1
0
mirror of https://github.com/gryf/wicd.git synced 2026-02-08 17:35:54 +01:00

Removed files that are generated by python setup.py configure

Added command to setup.py to clean out generated files ('cleargenerated')
Added the revision number to wicd-daemon.py --help
This commit is contained in:
Adam Blackburn
2008-12-30 10:31:06 -06:00
parent 1a98bf6890
commit ea69f2710e
18 changed files with 31 additions and 1066 deletions

View File

@@ -1,91 +0,0 @@
.\" Written by Robby Workman <rworkman@slackware.com>
.TH WICD-MANAGER-SETTINGS.CONF 5 "June 2008" "wicd-1.5.0"
.SH NAME
wicd-manager-settings.conf \- contains settings that control Wicd's behavior
.SH DESCRIPTION
This file contains general configuration information for Wicd.
.br
This file is located at /etc/wicd/manager-settings.conf
.SH SETTINGS
.TP
.BI "link_detect_tool = " <0|1|2>
0 = autodetect
.br
1 = ethtool
.br
2 = mii-tool
.TP
.BI "flush_tool = " <0|1|2>
0 = autodetect
.br
1 = ip
.br
2 = route
.TP
.BI "signal_display_type = " <0|1>
0 = Show signal strength as a percentage
.br
1 = Show signal strength in dBm
.TP
.BI "dhcp_client = " <0|1|2|3>
0 = autodetect
.br
1 = dhclient
.br
2 = dhcpcd
3 = pump
.TP
.BI "wired_interface = " <interface_name>
.TP
.BI "always_show_wired_interface = " <True|False>
.TP
.BI "wired_connect_mode = " <0|1>
0 = connect to wired interface automatically
.br
1 = do not connect to wired interface automatically
.TP
.BI "wireless_interface = " <name_of_wireless_interface>
.TP
.BI "wpa_driver = " <wext|madwifi|ndiswrapper|hostap|hermes|atmel|broadcom|ipw|ralink legacy>
The default (and best supported) is wext. It should work properly in most cases.
.TP
.BI "auto_reconnect = " <True|False>
This settings determines whether Wicd will attempt to reconnect on connection loss.
.TP
.BI "use_global_dns = " <True|False>
If set to "True" and values are specified in the global DNS settings below,
this will cause Wicd to use these DNS settings.
.TP
.BI "global_dns_1 = " <ip_address>
.TP
.BI "global_dns_2 = " <ip_address>
.TP
.BI "global_dns_3 = " <ip_address>
.TP
.BI "debug_mode = " <integer_value>
0 = disabled
.br
1 = enabled
.TP
.BI "window_height = " <integer_value> " (in pixels)"
This determines the height of the client window.
.TP
.BI "window_width = " <integer_value> " (in pixels)"
This determines the width of the client window.
.TP
.BI "pref_height = " <integer_value> " (in pixels)"
This determines the height of the "Preferences" window when launched from the client.
.TP
.BI "pref_width = " <integer_value> " (in pixels)"
This determines the width of the "Preferences" window when launched from the client.
.SH "SEE ALSO"
.BR wicd (8),
.BR wicd-wired-settings.conf (5),
.BR wicd-wireless-settings.conf (5).

View File

@@ -1,75 +0,0 @@
.\" Written by Robby Workman <rworkman@slackware.com>
.TH WICD-WIRED-SETTINGS.CONF 5 "June 2008" "wicd-1.5.0"
.SH NAME
wicd-wired-settings.conf \- controls Wicd's wired network settings
.SH DESCRIPTION
This file contains configuration information for wired interfaces in Wicd.
.br
This file is located at /etc/wicd/wired-settings.conf
.SH SETTINGS
.TP
.BI "default = " <0|1>
This option decides whether to use this profile as the default.
0 = do not use this profile as default.
.br
1 = use this profile as default.
.TP
.BI "beforescript = " <None|arbitrary_script>
This defines a script to run before Wicd brings up the connection.
The script should be a Bourne-compatible script and should be executable.
.br
IMPORTANT - scripts should ONLY be writable by root and located in a
directory that is only writable by root.
.TP
.BI "afterscript = " <None|arbitrary_script>
This defines a script to run after Wicd brings up the connection.
The script should be a Bourne-compatible script and should be executable.
.br
IMPORTANT - scripts should ONLY be writable by root and located in a
directory that is only writable by root.
.TP
.BI "disconnectscript = " <None|arbitrary_script>
This defines a script to run when Wicd disconnects the interface.
The script should be a Bourne-compatible script and should be executable.
.br
IMPORTANT - scripts should ONLY be writable by root and located in a
directory that is only writable by root.
.TP
.BI "ip = " <None|ip_address>
Use this option if you have a static ip address for your system.
.TP
.BI "netmask = " <None|network mask>
This setting is only appropriate if a static ip address is configured above.
.TP
.BI "broadcast = " <None|broadcast_address>
This setting is only appropriate if a static ip address is configured above.
.TP
.BI "gateway = " <None|gateway_address>
This setting is only appropriate if a static ip address is configured above.
.TP
.BI "use_static_dns = " <True|False>
True = use static DNS servers instead of accepting what the dhcp server supplies.
.TP
.BI "use_global_dns = " <True|False>
True = use the global DNS servers provided in wicd-manager-settings.conf(5).
This option is only appropriate if "use_static_dns = True"
.TP
.BI "dns1 = " <None|ip_address>
Static DNS address if "use_static_dns = True" and "use_global_dns = False"
.TP
.BI "dns2 = " <None|ip_address>
Static DNS address if "use_static_dns = True" and "use_global_dns = False"
.TP
.BI "dns3 = " <None|ip_address>
Static DNS address if "use_static_dns = True" and "use_global_dns = False"
.SH "SEE ALSO"
.BR wicd (8),
.BR wicd-manager-settings.conf (5),
.BR wicd-wireless-settings.conf (5).

View File

@@ -1,127 +0,0 @@
.\" Written by Robby Workman <rworkman@slackware.com>
.TH WICD-WIRELESS-SETTINGS.CONF 5 "June 2008" "wicd-1.5.0"
.SH NAME
wicd-wired-settings.conf \- controls Wicd's wireless network settings
.SH DESCRIPTION
This file contains configuration information for wireless interfaces in Wicd.
.br
This file is located at /etc/wicd/wireless-settings.conf
.SH SETTINGS
.TP
.BI "bssid = " <BSSID_of_network>
This value can be found using iwconfig(8).
.TP
.BI "essid = " <ESSID_of_network>
This value can be found using iwconfig(8).
.TP
.BI "hidden = " <True|False>
This option notes whether the network's ESSID is broadcast or not.
.TP
.BI "channel = " <integer_value>
Valid channels are dependent upon country.
.br
This value can be found using iwconfig(8).
.TP
.BI "mode = " <Master|Ad-hoc>
.br
This value can be found using iwconfig(8).
.TP
.BI "enctype = " <encryption_template>
This can take the value of any encryption template shown in /etc/wicd/encryption/templates/.
.TP
.BI "encryption_method = "WEP|WPA|WPA2>
This value can be found using iwconfig(8).
.TP
.BI "key = " <plain_text_key>
Be sure this file is readable only by root.
.TP
.BI "automatic = " <True|False>
This option determines whether Wicd should automatically connect to this
network.
.TP
.BI "ip = " <None|ip_address>
Use this option if you have a static ip address for your system.
.TP
.BI "netmask = " <None|network mask>
This setting is only appropriate if a static ip address is configured above.
.TP
.BI "broadcast = " <None|broadcast_address>
This setting is only appropriate if a static ip address is configured above.
.TP
.BI "gateway = " <None|gateway_address>
This setting is only appropriate if a static ip address is configured above.
.TP
.BI "use_static_dns = " <True|False>
True = use static DNS servers instead of accepting what the dhcp server supplies.
.TP
.BI "use_global_dns = " <True|False>
True = use the global DNS servers provided in wicd-manager-settings.conf(5).
.br
This option is only appropriate if "use_static_dns = True"
.TP
.BI "dns1 = " <None|ip_address>
Static DNS address if "use_static_dns = True" and "use_global_dns = False"
.TP
.BI "dns2 = " <None|ip_address>
Static DNS address if "use_static_dns = True" and "use_global_dns = False"
.TP
.BI "dns3 = " <None|ip_address>
Static DNS address if "use_static_dns = True" and "use_global_dns = False"
.TP
.BI "use_settings_globally = " <0|1>
Wicd keeps track of whether to autoconnect to networks based on bssid.
This ensures that you don't accidentally connect to another network that is
not yours but happens to have the same essid - for example, there are a lot
of commercial routers in use with "linksys" as the essid.
.br
0 = Do not use settings globally
.br
1 = Use settings globally
.TP
.BI "has_profile = " <True|False>
This parameter is used internally by Wicd and has no effect as far as the
user is concerned.
.TP
.BI "beforescript = " <None|arbitrary_script>
This defines a script to run before Wicd brings up the connection.
.br
IMPORTANT - scripts should ONLY be writable by root and should be located
in a directory that is writable by only root.
.TP
.BI "afterscript = " <None|arbitrary_script>
This defines a script to run after Wicd brings up the connection.
.br
IMPORTANT - scripts should ONLY be writable by root and located
in a directory that is writable by only root.
.TP
.BI "disconnectscript = " <None|arbitrary_script>
This defines a script to run when Wicd disconnects the interface.
.br
IMPORTANT - scripts should ONLY be writable by root and located
in a directory that is writable by only root.
.SH OTHER
The "use_settings_globally" option determines how an individual network's
configuration stanza starts. If the option is "0" (do not use settings
globally), then the stanza's top line will be the bssid of the access
point (in this format):
.br
[00:15:3E:87:D3:68]
.br
If the "option is set to "1" (use settings globally), then the first line
of the stanza will be in this format:
.br
[essid:UA Public Wireless Network]
.SH "SEE ALSO"
.BR wicd (8),
.BR wicd-manager-settings.conf (5),
.BR wicd-wired-settings.conf (5).

View File

@@ -1,161 +0,0 @@
.\" Written by Robby Workman <rworkman@slackware.com>
.TH WICD 8 "June 2008" "wicd-1.5.0"
.SH NAME
.B Wicd
\- Wired and Wireless Network Connection Manager
.SH THEORY OF OPERATION
Wicd is designed to give the user as much control over behavior of network
connections as possible. Every network, both wired and wireless, has its
own profile with its own configuration options and connection behavior.
Wicd will try to automatically connect only to networks the user specifies
it should try, with a preference first to a wired network, then to wireless.
For wired connections, users have many options for determining what network
settings to use. Wicd allows creation of an unlimited number of wired
profiles, each of which has its own unique settings. The user can choose to
automatically connect to a selected default profile, choose a profile from a
pop-up window every time wicd connects, or have wicd automatically choose the
last profile used to manually connect.
For wireless connections, users can select any number of wireless networks
to automatically connect; wicd will choose the one with the highest signal
strength to try to connect.
If the user chooses, wicd will try to automatically reconnect when it detects
that a connection is lost. If the last known connection state is wired, wicd
will first try to reconnect to the wired network, and if it is not available,
wicd will try any available wireless networks which have automatic connection
enabled. If the last known connection state is wireless, wicd will first try
to reconnect to the previously connected network (even if that network does
not have automatic connection enabled), and should that fail, it will try both
a wired connection and any available wireless networks which have automatic
connection enabled.
Wicd uses built-in linux wireless-tools, such as ifconfig and iwconfig, to
get and configure network info. There is some flexibility in its use of DHCP,
providing support for dhclient, dhcpcd, and pump. Wicd uses wpa_supplicant
to handle all wireless encryption settings, and uses a template-based system
to create the configuration files used by wpa_supplicant. These templates
can be edited, and new templates can be created by the user and imported into
wicd, allowing connection to networks with uncommon encryption settings.
.SH STRUCTURE
Wicd has two major parts: the daemon, which runs with root privileges; and the
user interface, which runs with normal user privileges. The two parts run as
separate processes and make use of D-Bus to communicate.
The daemon is responsible for making and configuring connections, reading and
writing configuration files and logs, and monitoring the connection status.
The daemon's job is split between two processes: wicd-daemon.py and monitor.py.
All the connection status monitoring, as well as the auto-reconnection logic,
takes place in monitor.py. Everthing else is done by wicd-daemon.py.
The user interface (stored in wicd-client), which is made up of a tray
icon, a main GUI window, and its child dialogs, gets configuration and network
info from the daemon either by querying it using the methods in the daemon's
dbus interface or by receiving signals emitted from the daemon over D-Bus.
Any configuration changes made in the user interface are passed back to the
daemon, which actually applies the changes and writes them to configuration
files.
Since the user interface just queries for connection and configuration info
from the daemon, it is possible to run wicd without the GUI at all. Also,
the daemon is started by wicd's init script during system startup (before any
user logs in), making it possible to use wicd with "headless" machines.
.SH USAGE HINTS
.B Choosing Alternate Tools
.br
Wicd supports several alternatives regarding the networking tools on linux.
In the "External Programs" tab of the Preferences menu, you can choose your
preferred DHCP client, link detection tool, and routing tool if the defaults
aren't suitable for your particular distribution or system.
.B Custom Scripts
.br
If you need to run any custom commands before or after connecting to or
disconnecting from a network, Wicd supports this; however, you will need to
have a graphical sudo helper installed (currently supported are kdesu, gksu,
and ktsuss).
.br
If you do not have a graphical sudo helper installed, you still have the
ability to use custom scripts, but you will have to set them up manually.
See wicd-wired-settings.conf(5) and/or wicd-wireless-settings.conf(5) for
more information on how to do so.
.B Automatically Connecting to Networks
.br
Wicd uses the BSSID to recognize a particular network (and thus to decide
whether it should automatically connect to it). If you are on a network
that has many different access points which all have the same ESSID
(many universities have such networks), there is an option in the "Advanced
Settings" to "Use these settings for all networks sharing this essid."
With this option enabled, Wicd will autoconnect to that network, regardless
of which node it sees.
.SH FILES
.B /etc/wicd/manager-settings.conf
.br
This file contains global settings for Wicd.
.br
See this file's own man page for more information about it.
.B /etc/wicd/wired-settings.conf
.br
This file contains settings related to the wired interface.
.br
See this file's own man page for more information about it.
.B /etc/wicd/wireless-settings.conf
.br
This file contains settings related to the wireless interface.
.br
See this file's own man page for more information about it.
.B /etc/wicd/encryption/templates/
.br
This directory contains various templates for encrypted (WEP, WPA, etcetera)
connections. If none of them fit your needs, you may create your own and
add it to this directory. If you do this, please contact the authors
(see below) of Wicd.
.B /var/lib/wicd/configurations/
.br
This directory contains individual configuration files for each encrypted
network you set up in Wicd.
.B /var/log/wicd/
.br
This directory contains logfiles of Wicd's activity. Please refer to the
log if you are having connection or other problems.
.SH "SEE ALSO"
.BR wicd-manager-settings.conf (5),
.BR wicd-wired-settings.conf (5),
.BR wicd-wireless-settings.conf (5),
.BR ifconfig (8),
.BR iwconfig (8),
.BR wpa_supplicant (8),
.BR route (8),
.BR ip (8),
.BR mii-tool (8),
.BR ethtool (8),
.BR dhclient (8),
.BR dhcpcd (8),
.BR pump (8).
.SH WICD AUTHORS
Adam Blackburn <compwiz18@gmail.com>
.br
Dan O'Reilly <oreilldf@gmail.com>
.SH MANPAGE AUTHOR
Robby Workman <rworkman@slackware.com>