diff options
| -rwxr-xr-x | docs/make.sh | 7 | ||||
| -rw-r--r-- | docs/man/netcfg.8 | 74 | ||||
| -rw-r--r-- | docs/netcfg.txt | 96 |
3 files changed, 102 insertions, 75 deletions
diff --git a/docs/make.sh b/docs/make.sh index 76a30af..42bb7fc 100755 --- a/docs/make.sh +++ b/docs/make.sh @@ -9,9 +9,14 @@ make_page() { for page in ${PAGES[@]}; do rm -f ${page}.html - if [ -f /usr/bin/pandoc ]; then + if which pandoc &>/dev/null; then pandoc -s --toc -w html --email-obfuscation=javascript -c header.css -o ${page}.html $page else make_page $page > ${page}.html fi done + +# Generate manpages +if which pandoc &>/dev/null; then + pandoc -s -w man -o netcfg.8 netcfg.txt +fi diff --git a/docs/man/netcfg.8 b/docs/man/netcfg.8 deleted file mode 100644 index 5bbab66..0000000 --- a/docs/man/netcfg.8 +++ /dev/null @@ -1,74 +0,0 @@ -.TH NETCFG 8 "AUGUST 2009" "Arch Linux" "Network Scripts" -.\" groff -man -Tascii foo.1 -.SH NAME -netcfg \- start/stop/control network profiles -.SH SYNOPSIS -netcfg [\fIoptions\fR] \fBprofile\fR - -netcfg \fBprofile\fR -.SH DESCRIPTION -\fBnetcfg\fP is used to configure and manage network connections via profiles. It has pluggable support for a range of connection types, such as wireless, ethernet. ppp. It is also capable of starting/stopping many to one connections, that is, multiple connections within the same profile, optionally with bonding. - -It may be run at boot, by enabling the \fI/etc/rc.d/net-profiles\fP daemon in \fI/etc/rc.conf\fP \fBDAEMONS\fP line. After boot time, it may be used to start profiles, simply by passing only the profile name. - -.SH OPTIONS -.TP -.B \-c, check-iface \fIprofile\fP -Start the specified profile, only if it's interface is not currently up. -.TP -.B \-d, down \fIprofile\fP -Stop the specified profile -.TP -.B \-r, reconnect \fIprofile\fP -Disconnect and reconnect the specified profile -.TP -.B \-i, iface-down \fBinterface\fP -Stop the profile up on the specified interface. -.TP -.B \-a, all-down -Stop all connected profiles -.TP -.B all-suspend -Suspend and store the name of all active profiles. -.TP -.B all-resume -Reconnect any profiles that have been suspended. -.TP -.B current -Report currently running profiles -.TP -.B \-l, list -List all available profiles -.TP -.B \-v, --version -Display version information and exit -.TP -.B \-h, --help -Display help message and exit - -.SH FILES -.TP -.I /usr/lib/network/ -Currently installed network profile types. -.TP -.I /etc/network.d/examples -Example configurations for this script -.TP -.I /etc/network.d/hooks -See /usr/share/doc/netcfg/contrib for examples. - -.SH ENVIRONMENT VARIABLES -.TP -.I NETCFG_DEBUG -Set to 'yes' to activate debugging output. - -.SH BUGS -None, hopefully, but if you do find one of these elusive things, please submit at http://bugs.archlinux.org/ or email one of the authors below. -.SH AUTHOR -James Rayner <james@archlinux.org> - -Others listed in AUTHORS file in source. -.SH SEE ALSO -.BR ethernet (5), -.BR iwconfig (8), -.BR wireless (5) diff --git a/docs/netcfg.txt b/docs/netcfg.txt new file mode 100644 index 0000000..18394ff --- /dev/null +++ b/docs/netcfg.txt @@ -0,0 +1,96 @@ +% NETCFG(8) netcfg 2.6.4 | Arch Linux +% Rémy Oudompheng <remy@archlinux.org> + James Rayner <james@archlinux.org> +% July 2011 + +NAME +==== +netcfg -- start/stop/control network profiles + +SYNOPSIS +======== +netcfg [*options*] + +netcfg **profile** + +DESCRIPTION +=========== +**netcfg** is used to configure and manage network connections via +profiles. It has pluggable support for a range of connection types, such +as wireless, ethernet, ppp. It is also capable of starting/stopping many +to one connections, that is, multiple connections within the same +profile, optionally with bonding. + +It may be run at boot, by enabling the */etc/rc.d/net-profiles* +daemon in */etc/rc.conf* **DAEMONS** line. After boot time, it may +be used to start profiles, simply by passing only the profile name. + +When run without options, netxfg **profile** is equivalent to *netcfg -u +profile*. + +OPTIONS +======= + +`-l`, list +: List all available profiles +current +: Report currently running profiles +`-c`, check-iface *profile* +: Start the specified profile, only if it's interface is not currently up. + +`-u`, up *profile* +: Start the specified profile +`-r`, reconnect *profile* +: Disconnect and reconnect the specified profile + +`-d`, down *profile* +: Stop the specified profile +`-i`, iface-down *interface* +: Stop the profile up on the specified interface. +`-a`, all-down +: Stop all connected profiles + +all-suspend +: Suspend and store the name of all active profiles. +all-resume +: Reconnect any profiles that have been suspended. + +`-v`, `--version` +: Display version information and exit +`-h`, `--help` +: Display help message and exit + +CONFIGURATION FILES +=================== + +*/etc/conf.d/netcfg* +: Parameters for startup. +*/etc/network.d/* +: User-defined profiles. + +FILES +===== +*/usr/lib/network/connections/* +: Currently installed network profile types. +*/etc/network.d/examples/* +: Example profiles. +*/etc/network.d/hooks/* +: See /usr/share/doc/netcfg/contrib for examples. + +ENVIRONMENT VARIABLES +===================== + +**NETCFG_DEBUG** +: Set to 1 to activate debug output. + +BUGS +==== + +None, hopefully, but if you do find one of these elusive things, +please submit at http://bugs.archlinux.org/ or email one of the authors +below. + +SEE ALSO +======== + +**netcfg-profiles**(5) for how to configure netcfg. |