.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "NCFTOOL 1" .TH NCFTOOL 1 "2014-02-24" "netcf-0.2.4" "Network Configuration" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" ncftool \- Network configuration tool .SH "SYNOPSIS" .IX Header "SYNOPSIS" ncftool [command [options]] .SH "DESCRIPTION" .IX Header "DESCRIPTION" ncftool is a command line utility to configure networking. It can be invoked with no arguments to bring up the interactive ncftool shell. Alternatively a command and optional arguments can be specified to have ncftool execute the command non-interactively. .SH "COMMANDS" .IX Header "COMMANDS" .SS "\fBlist [\-\-macs] [\-\-all] [\-\-inactive]\fP" .IX Subsection "list [--macs] [--all] [--inactive]" List the currently configured toplevel network interfaces .IP "\fB[\-\-macs]\fR \- show \s-1MAC\s0 addresses" 4 .IX Item "[--macs] - show MAC addresses" .PD 0 .IP "\fB[\-\-all]\fR \- show all (up & down) interfaces" 4 .IX Item "[--all] - show all (up & down) interfaces" .IP "\fB[\-\-inactive]\fR \- show only inactive (down) interfaces" 4 .IX Item "[--inactive] - show only inactive (down) interfaces" .PD .SS "\fBdumpxml [\-\-mac] [\-\-live] name\fP" .IX Subsection "dumpxml [--mac] [--live] name" Dump the \s-1XML\s0 description of an interface .IP "\fB[\-\-mac]\fR \- interpret the name as \s-1MAC\s0 address" 4 .IX Item "[--mac] - interpret the name as MAC address" .PD 0 .IP "\fB[\-\-live]\fR \- include information about the live interface" 4 .IX Item "[--live] - include information about the live interface" .IP "\fBname\fR \- the name of the interface" 4 .IX Item "name - the name of the interface" .PD .SS "\fBdefine xmlfile\fP" .IX Subsection "define xmlfile" Define an interface from the specified \s-1XML\s0 file. .SS "\fBundefine iface\fP" .IX Subsection "undefine iface" Remove the configuration of the specified interface. .SS "\fBifup iface\fP" .IX Subsection "ifup iface" Bring up specified interface. .SS "\fBifdown iface\fP" .IX Subsection "ifdown iface" Bring down specified interface. .SS "\fBchange-begin\fP" .IX Subsection "change-begin" Mark the beginning of a set of revertible network configuration changes. .SS "\fBchange-commit\fP" .IX Subsection "change-commit" Commit (make permanent) a set of network configuration changes begun with \fBchange-begin\fR. .SS "\fBchange-rollback\fP" .IX Subsection "change-rollback" Rollback (revert) a set of network configuration changes begun with \&\fBchange-begin\fR. .SS "\fBhelp [command]\fP" .IX Subsection "help [command]" Print details about command, if specified, or list all commands if command is not specified. .SS "quit" .IX Subsection "quit" Exit the program. .SH "SEE ALSO" .IX Header "SEE ALSO" interfaces (5) .SH "AUTHORS" .IX Header "AUTHORS" Please refer to the \s-1AUTHORS\s0 file distributed with netcf.