conn

A script repository to manage connections in Linux.
git clone git://r-36.net/conn
Log | Files | Refs | README | LICENSE

README.md (1987B)


      1 # Conn - connection scripts 
      2 
      3 This collection of scripts is intended to standardize the way to handle
      4 many different connections in a Unix like environment.
      5 
      6 ## Dependencies
      7 
      8 * sh
      9 * dhcpcd
     10 * wpa-supplicant
     11 * ping
     12 * awk
     13 * sed
     14 * various utilities for specific connection types
     15 	* rfkill for wwan
     16 * pm-utils (for suspend support)
     17 
     18 ## Installation
     19 
     20 Just run:
     21 
     22 	make install
     23 
     24 To install the conection examples from the distribution run:
     25 
     26 	make examples
     27 
     28 The installation of the pm scripts needs following command:
     29 
     30 	make pm
     31 
     32 ## Architecture
     33 
     34 /usr/bin/conn	 	The main script, which accesses all functionality.
     35 
     36 /etc/conn/run.sh 	The script which conn calls and does the redirection
     37 			to the connections.
     38 
     39 /etc/conn 		The base directory for all logic behind connd.
     40 
     41 /etc/conn/common.sh 	Common functions all scripts can use.
     42 
     43 /etc/conn/$conn		These are the connection types which are available.
     44 
     45 /etc/conn/$conn/run.sh	This script is run in every connection, when the
     46 			connection is invoked by the run.sh in the main
     47 			etc directory.
     48 
     49 /etc/conn/$conn/$files	These files depend solely on the connection, which
     50 			is served. Look at them for details.
     51 
     52 /etc/pm/sleep.d/10-conn.sh	The script for providing suspend and hib-
     53 				ernate support.
     54 
     55 ### Calltree
     56 * conn
     57 	* conn/run.sh
     58 		* conn/$conn/run.sh
     59 			* conn/$conn/$files
     60 
     61 ### Examples
     62 
     63 	% conn -l
     64 	Available network types:
     65 	eth
     66 	wifi
     67 	wwan
     68 	# Connect to the wifi
     69 	% conn -s wifi
     70 	# HUP wpa_supplicant
     71 	% conn -u wifi
     72 	# Kill the wifi
     73 	% conn -k wifi
     74 	# Start ethernet
     75 	% conn -s eth
     76 	# Kill the ethernet
     77 	% conn -k eth
     78 	# Start the wwan
     79 	% conn -s wwan
     80 	# Suspend all connections
     81 	% conn -n
     82 	# Wakeup all previous connections
     83 	% conn -w
     84 
     85 ## Suspend
     86 
     87 If there is any connection open, when a hibernate or suspend event
     88 occurs, then conn will shut them down, but keeps them in the list
     89 of open connections. This list is used when the wakeup occurs, for
     90 restarting these connections.
     91 
     92 You need to »make pm« for installing the conn pm script.
     93