Index: head/usr.bin/dpv/dpv.1 =================================================================== --- head/usr.bin/dpv/dpv.1 (revision 276257) +++ head/usr.bin/dpv/dpv.1 (revision 276258) @@ -1,428 +1,428 @@ .\" Copyright (c) 2013-2014 Devin Teske .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd Sep 7, 2014 .Dt DPV 1 .Os .Sh NAME .Nm dpv .Nd stream data from stdin or multiple paths with dialog progress view .Sh SYNOPSIS .Nm .Op options .Ar [bytes:]label .Nm .Op options .Fl m .Ar [bytes1:]label1 .Ar path1 .Op Ar [bytes2:]label2 path2 ... .Sh DESCRIPTION .Nm provides a dialog progress view, allowing a user to see current throughput rate and total data transferred for one or more streams. .Pp The .Nm utility has two main modes for processing input. .Pp The default input mode, without .Ql Fl m , .Nm reads bytes from standard input. A label for the data must be provided. .Pp The secondary input mode, with .Ql Fl m , .Nm reads multiple paths .Pq up to 2047 or Dq ARG_MAX/2-1 , sequentially. .Pp Data read in either mode is either thrown away .Pq default , sent to a spawned instance of the program specified via .Ql Fl x Ar cmd , or sent to a unique file specified by .Ql Fl o Ar file . .Pp With or without .Ql Fl m , progress is displayed using one of .Xr dialog 3 .Pq default , .Xr dialog 1 .Pq see Ql Fl D , or instead .Xr Xdialog 1 .Pq see Ql Fl X . .Pp The following options are available: .Bl -tag -width ".Fl b Ar backtitle" .It Fl a Ar text Display .Ar text below the file progress indicator(s). .It Fl b Ar backtitle Display .Ar backtitle on the backdrop, at top-left, behind the dialog widget. When using .Xr Xdialog 1 , this is displayed inside the window .Pq at the top followed by a separator line. .It Fl d Debug mode. Print dialog prompt data to standard out and provide additional debugging on standard error. .It Fl D Do not use the default interface of .Xr dialog 3 , but instead spawn an instance of .Xr dialog 1 . The path to .Xr dialog 1 is taken from the .Ev DIALOG environment variable or simply .Dq Li dialog if unset or NULL. .It Fl h Produce a short syntax usage with brief option descriptions and exit. Output is produced on standard error. .It Fl i Ar format Customize the single-file format string used to update the status line. Ignored when using either .Ql Fl D or .Ql Fl X which lack the ability to display the status line .Pq containing bytes/rate/thread information . Default value is .Dq Li %'10lli bytes read @ %'9.1f bytes/sec. . This format is used when handling one file. .It Fl I Ar format Customize the multi-file format string used to update the status line. Ignored when using either .Ql Fl D or .Ql Fl X which lack the ability to display the status line .Pq containing bytes/rate/thread information . Default value is .Dq Li %'10lli bytes read @ %'9.1f bytes/sec. [%i/%i busy/wait] . This format is used when handling more than one file. .It Fl l Line mode. Read lines from input instead of bytes. .It Fl L Ar size Label size. If negative, shrink to longest label width. .It Fl m Multi-input mode. Instead of reading bytes from standard input, read from a set of paths .Pq one for each label . By default, each path is processed sequentially in the order given. .It Fl n Ar num Display at-most .Ar num progress indicators per screen. If zero, display as many as possible. If negative, only display the main progress indicator. Default is 0. Maximum value is 10. .It Fl N No overrun. If enabled, stop reading known-length inputs when input reaches stated length. .It Fl o Ar file Output data to .Ar file . The first occurrence of .Ql %s .Pq if any in .Ql Ar file will be replaced with the .Ar label text. .It Fl p Ar text Display .Ar text above the file progress indicator(s). .It Fl P Ar size Mini-progressbar size. If negative, don't display mini-progressbars .Pq only the large overall progress indicator is shown . If zero, auto-adjust based on number of files to read. When zero and only one file to read, defaults to -1. When zero and more than one file to read, defaults to 17. .It Fl t Ar title Display .Ar title atop the dialog box. Note that if you use this option at the same time as .Ql Fl X and .Ql Fl b Ar backtitle , the .Ar backtitle and .Ar title are effectively switched .Pq see BUGS section below . .It Fl T Test mode. Simulate reading a number of bytes, divided evenly across the number of files, while stepping through each percent value of each file to process. Appends .Dq Li [TEST MODE] to the status line .Pq to override, use Ql Fl u Ar format . No data is actually read. .It Fl U Ar num Update status line .Ar num times per-second. Default value is .Ql Li 2 . A value of .Ql Li 0 disables status line updates. If negative, update the status line as fast as possible. Ignored when using either .Ql Fl D or .Ql Fl X which lack the ability to display the status line .Pq containing bytes/rate/thread information . .It Fl w Wide mode. Allows long .Ar text arguments used with .Ql Fl p and .Ql Fl a to bump the dialog width. Prompts wider than the maximum width will wrap .Pq unless using Xr Xdialog 1 ; see BUGS section below . .It Fl x Ar cmd Execute .Ar cmd .Pq via Xr sh 1 and send it data that has been read. Data is available to .Ar cmd on standard input. With .Ql Fl m , .Ar cmd is executed once for each .Ar path argument. The first occurrence of .Ql %s .Pq if any in .Ql Ar cmd will be replaced with the .Ar label text. .It Fl X Enable X11 mode by using .Xr Xdialog 1 instead of .Xr dialog 1 or .Xr dialog 3 . .El .Sh ENVIRONMENT The following environment variables are referenced by .Nm : .Bl -tag -width ".Ev USE_COLOR" .It Ev DIALOG Override command string used to launch .Xr dialog 1 .Pq requires Ql Fl D or .Xr Xdialog 1 .Pq requires Ql Fl X ; default is either .Ql dialog .Pq for Ql Fl D or .Ql Xdialog .Pq for Ql Fl X . .It Ev DIALOGRC If set and non-NULL, path to .Ql .dialogrc file. .It Ev HOME If .Ql Ev $DIALOGRC is either not set or NULL, used as a prefix to .Ql .dialogrc .Pq i.e., Ql $HOME/.dialogrc . .It Ev USE_COLOR If set and NULL, disables the use of color when using .Xr dialog 1 .Pq does not apply to Xr Xdialog 1 . .El .Sh DEPENDENCIES If using .Ql Fl D , .Xr dialog 1 is required. .Pp If using .Ql Fl X , .Xr Xdialog 1 is required. .Sh FILES .Bl -tag -width ".Pa $HOME/.dialogrc" -compact .It Pa $HOME/.dialogrc .El .Sh EXAMPLES Simple example to show how fast .Xr yes 1 produces lines .Pq usually about ten-million per-second; your results may vary : .Bd -literal -offset indent yes | dpv -l yes .Ed .Pp Display progress while timing how long it takes .Xr yes 1 to produce a half-billion lines .Pq usually under one minute; your results may vary : .Bd -literal -offset indent time yes | dpv -Nl 500000000:yes .Ed .Pp An example to watch how quickly a file is transferred using .Xr nc 1 : .Bd -literal -offset indent dpv -x "nc -w 1 somewhere.com 3000" -m label file .Ed .Pp A similar example, transferring a file from another process and passing the expected size to .Nm : .Bd -literal -offset indent cat file | dpv -x "nc -w 1 somewhere.com 3000" 12345:label .Ed .Pp A more complicated example: .Bd -literal -offset indent tar cf - . | dpv -x "gzip -9 > out.tgz" \\ $( du -s . | awk '{print $1 * 1024}' ):label .Ed .Pp Taking an image of a disk: .Bd -literal -offset indent dpv -o disk-image.img -m label /dev/ada0 .Ed .Pp Writing an image back to a disk: .Bd -literal -offset indent dpv -o /dev/ada0 -m label disk-image.img .Ed .Pp Zeroing a disk: .Bd -literal -offset indent dpv -o /dev/md42 < /dev/zero .Ed .Sh SEE ALSO .Xr dialog 1 , -.Xr dialog 3 , .Xr sh 1 , -.Xr Xdialog 1 +.Xr Xdialog 1 , +.Xr dialog 3 .Sh HISTORY A .Nm utility first appeared in .Fx 11.0 . .Sh AUTHORS .An Devin Teske Aq dteske@FreeBSD.org .Sh BUGS .Xr Xdialog 1 , when given both .Ql Fl -title Ar title .Pq see above Ql Fl t Ar title and .Ql Fl -backtitle Ar backtitle .Pq see above Ql Fl b Ar backtitle , displays the backtitle in place of the title and vice-versa. .Pp .Xr Xdialog 1 does not wrap long prompt texts received after initial launch. This is a known issue with the .Ql --gauge widget in .Xr Xdialog 1 . .Pp .Xr dialog 1 does not display the first character after a series of escaped escape-sequences (e.g., ``\\\\n'' produces ``\\'' instead of ``\\n''). This is a known issue with .Xr dialog 1 and does not affect .Xr dialog 3 or .Xr Xdialog 1 . .Pp If your application ignores .Ev USE_COLOR when set and NULL before calling .Xr dpv 1 with color escape sequences anyway, .Xr dialog 3 and .Xr dialog 1 may not render properly. Workaround is to detect when .Ev USE_COLOR is set and NULL and either not use color escape sequences at that time or use .Xr unset 1 .Xr [ sh 1 ] or .Xr unsetenv 1 .Xr [ csh 1 ] to unset .Ev USE_COLOR , forcing interpretation of color sequences. This does not effect .Xr Xdialog 1 , which renders the color escape sequences as plain text. See .Do embedded "\\Z" sequences .Dc in .Xr dialog 1 for additional information. Index: head/usr.bin/iscsictl/iscsi.conf.5 =================================================================== --- head/usr.bin/iscsictl/iscsi.conf.5 (revision 276257) +++ head/usr.bin/iscsictl/iscsi.conf.5 (revision 276258) @@ -1,188 +1,188 @@ .\" Copyright (c) 2007-2010 Daniel Braniss .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd December 17, 2013 .Dt ISCSI.CONF 5 .Os .Sh NAME .Nm iscsi.conf .Nd iSCSI initiator configuration file .Sh DESCRIPTION The file .Nm , is used by the .Xr iscsictl 8 and .Xr iscontrol 8 utilities. It contains declarations and parameter/key-options. The syntax is very simple, .D1 Li variable = value; and they can be grouped via a .Em block declaration: .Bf Li .Bd -literal # this is a comment target_1 { # nickname variable = value; ... } # this must be on a line by itself. .Ed .Ef .Pp The following are specified in the iSCSI RFC 3720, for a full description see sections 11/12 of the RFC. .Bl -tag -width MaxConnections .It Cm AuthMethod currently only supported authentication method is CHAP, with digest either MD5 or SHA. Default is none. .It Cm HeaderDigest a .Em digest is calculated on the header of all iSCSI PDUs, and checked. Only CRC32C is implemented. Default is none. .It Cm DataDigest same as for HeaderDigest, but on the data part of the iSCSI PDU. (not yet tested) .It Cm TargetName is the name by which the target is known, not to be confused with target address, either obtained via the target administrator, or from a .Em discovery session . .It Cm InitiatorName if not specified, defaults to .Sy iqn.2005-01.il.ac.huji.cs: .Aq hostname . .It Cm TargetAddress is of the form .Sy domainname[:port][,portal-group-tag] to quote the RFC: .Bd -ragged -compact The domainname can be specified as either a DNS host name, a dotted-decimal IPv4 address, or a bracketed IPv6 address as specified in [RFC2732]. .Ed Note: portal-group-tag is unused at the moment. .Em not implemented yet. .It Cm MaxRecvDataSegmentLength the maximum data segment length in bytes it can receive in an iSCSI PDU, default is 8192. .It Cm MaxOutstandingR2T is used to calculate/negotiate the .Em tag opening , can be overridden by the .Sy tag option. .It Cm SessionType either Discovery or Normal, default is Normal, see the .Fl d flag of .Cm iscontrol . .El .sp The following are not specified in the .Sy RFC 3720 .Bl -tag -width sockbufsize .It Cm port The iSCSI port used by the iSCSI protocol, defaults to 3260. .It Cm tags Sets the .Em tag opening to the value specified. .It Cm maxluns overrides the compiled value of .Sy luns , see .Xr iscsi_initiator 4 . This value can only be reduced. .It Cm sockbufsize sets the receiver and transmitter socket buffer size to .Em size , in kilobytes. The default is 128. .El .sp If .Em AuthMethod is set to .Cm CHAP , then the following must also be set: .Bl -tag -width chapSecret .It Cm chapSecret this .Em shared-secret . Can be either an ASCII string (e.g. hello world), a hex string (e.g 0xababcd0987654321...), or base64 string (eg 0b...) .It Cm chapIName the chap-name, defaults to .Em hostname . .It Cm chapDigest can be MD5 or SHA1. .It Cm tgtChapName/tgtChapSecret name and secret used for mutual CHAP; by default, mutual CHAP is not used. .El .Sh FILES .Bl -tag -width indent .It Pa /etc/iscsi.conf .El .Sh EXAMPLES .Bd -literal # # Globals # port = 3260 # myiscsi { # nickname targetaddress = iscsi1 targetname = iqn.1900.com.com:sn.123456 } chaptest { targetaddress= 10.0.0.1; targetname = iqn.1900.com.com:sn.123456 initiatorname= iqn.2005-01.il.ac.huji.cs:nobody authmethod = CHAP; chapDigest = SHA1; chapsecret = 0x3713c3336d9a224c2791c873d3d2b174 tags = 256 } .Ed .Sh SEE ALSO .Xr iscsi_initiator 4 , -.Xr iscsictl 8 , -.Xr iscontrol 8 +.Xr iscontrol 8 , +.Xr iscsictl 8 .Sh STANDARDS ISCSI RFC 3720 .\"Sh HISTORY .\"Sh AUTHORS .Sh BUGS Some options have not been implemented, either they were found to be unnecessary, or not understood, this can change in the future. .br The tags opening value is difficult to calculate, use wisely. Index: head/usr.bin/last/last.1 =================================================================== --- head/usr.bin/last/last.1 (revision 276257) +++ head/usr.bin/last/last.1 (revision 276258) @@ -1,216 +1,216 @@ .\" Copyright (c) 1980, 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)last.1 8.1 (Berkeley) 6/6/93 .\" $FreeBSD$ .\" .Dd January 21, 2010 .Dt LAST 1 .Os .Sh NAME .Nm last .Nd indicate last logins of users and ttys .Sh SYNOPSIS .Nm .Op Fl swy .Oo .Fl d .Sm off .Op Oo Ar CC Oc Ar YY .Op Ar MM DD .Ar hh mm .Op Ar .SS .Sm on .Oc .Op Fl f Ar file .Op Fl h Ar host .Op Fl n Ar maxrec .Op Fl t Ar tty .Op Ar user ... .Sh DESCRIPTION The .Nm utility will either list the sessions of specified .Ar users , .Ar ttys , and .Ar hosts , in reverse time order, or list the users logged in at a specified date and time. Each line of output contains the user name, the tty from which the session was conducted, any hostname, the start and stop times for the session, and the duration of the session. If the session is still continuing or was cut short by a crash or shutdown, .Nm will so indicate. .Pp The following options are available: .Bl -tag -width indent-two .It Fl d Ar date Specify the snapshot date and time. All users logged in at the snapshot date and time will be reported. This may be used with the .Fl f option to derive the results from stored .Pa utx.log files. When this argument is provided, all other options except for .Fl f and .Fl n are ignored. The argument should be in the form .Sm off .Op Oo Ar CC Oc Ar YY .Op Ar MM DD .Ar hh mm .Op Ar .SS .Sm on where each pair of letters represents the following: .Pp .Bl -tag -width Ds -compact -offset indent .It Ar CC The first two digits of the year (the century). .It Ar YY The second two digits of the year. If .Ar YY is specified, but .Ar CC is not, a value for .Ar YY between 69 and 99 results in a .Ar CC value of 19. Otherwise, a .Ar CC value of 20 is used. .It Ar MM Month of the year, from 1 to 12. .It Ar DD Day of the month, from 1 to 31. .It Ar hh Hour of the day, from 0 to 23. .It Ar mm Minute of the hour, from 0 to 59. .It Ar SS Second of the minute, from 0 to 61. .El .Pp If the .Ar CC and .Ar YY letter pairs are not specified, the values default to the current year. If the .Ar SS letter pair is not specified, the value defaults to 0. .It Fl f Ar file Read the file .Ar file instead of the default, .Pa /var/log/utx.log . .It Fl h Ar host .Ar Host names may be names or internet numbers. .It Fl n Ar maxrec Limit the report to .Ar maxrec lines. .It Fl s Report the duration of the login session in seconds, instead of the default days, hours and minutes. .It Fl t Ar tty Specify the .Ar tty . Tty names may be given fully or abbreviated, for example, .Dq Li "last -t 03" is equivalent to .Dq Li "last -t tty03" . .It Fl w Widen the duration field to show seconds, as well as the default days, hours and minutes. .It Fl y Report the year in the session start time. .El .Pp If multiple arguments are given, and a snapshot time is not specified, the information which applies to any of the arguments is printed, e.g., .Dq Li "last root -t console" would list all of .Dq Li root Ns 's sessions as well as all sessions on the console terminal. If no users, hostnames or terminals are specified, .Nm prints a record of all logins and logouts. .Pp The pseudo-user .Ar reboot logs in at reboots of the system, thus .Dq Li last reboot will give an indication of mean time between reboot. .Pp If .Nm is interrupted, it indicates to what date the search has progressed. If interrupted with a quit signal .Nm indicates how far the search has progressed and then continues. .Sh FILES .Bl -tag -width /var/log/utx.log -compact .It Pa /var/log/utx.log login data base .El .Sh SEE ALSO .Xr lastcomm 1 , -.Xr lastlogin 8 , .Xr getutxent 3 , -.Xr ac 8 +.Xr ac 8 , +.Xr lastlogin 8 .Sh HISTORY A .Nm utility appeared in .Bx 3.0 . .Sh BUGS If a login shell should terminate abnormally for some reason, it is likely that a logout record will not be written to the .Pa utx.log file. In this case, .Nm will indicate the logout time as "shutdown". Index: head/usr.bin/man/man.1 =================================================================== --- head/usr.bin/man/man.1 (revision 276257) +++ head/usr.bin/man/man.1 (revision 276258) @@ -1,365 +1,365 @@ .\"- .\" Copyright (c) 2010 Gordon Tetlow .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd September 26, 2014 .Dt MAN 1 .Os .Sh NAME .Nm man .Nd display online manual documentation pages .Sh SYNOPSIS .Nm .Op Fl adho .Op Fl t | w .Op Fl M Ar manpath .Op Fl P Ar pager .Op Fl S Ar mansect .Op Fl m Ar arch Ns Op : Ns Ar machine .Op Fl p Op Ar eprtv .Op Ar mansect .Ar page ... .Nm .Fl f .Ar keyword ... .Nm .Fl k .Ar keyword ... .Sh DESCRIPTION The .Nm utility finds and displays online manual documentation pages. If .Ar mansect is provided, .Nm restricts the search to the specific section of the manual. .Pp The sections of the manual are: .Bl -enum -offset indent -compact .It .Fx General Commands Manual .It .Fx System Calls Manual .It .Fx Library Functions Manual .It .Fx Kernel Interfaces Manual .It .Fx File Formats Manual .It .Fx Games Manual .It .Fx Miscellaneous Information Manual .It .Fx System Manager's Manual .It .Fx Kernel Developer's Manual .El .Pp Options that .Nm understands: .Bl -tag -width indent .It Fl M Ar manpath Forces a specific colon separated manual path instead of the default search path. See .Xr manpath 1 . Overrides the .Ev MANPATH environment variable. .It Fl P Ar pager Use specified pager. Defaults to .Dq Li "less -sR" if color support is enabled, or .Dq Li "more -s" . Overrides the .Ev MANPAGER environment variable, which in turn overrides the .Ev PAGER environment variable. .It Fl S Ar mansect Restricts manual sections searched to the specified colon delimited list. Defaults to .Dq Li 1:8:2:3:n:4:5:6:7:9:l . Overrides the .Ev MANSECT environment variable. .It Fl a Display all manual pages instead of just the first found for each .Ar page argument. .It Fl d Print extra debugging information. Repeat for increased verbosity. Does not display the manual page. .It Fl f Emulate .Xr whatis 1 . .It Fl h Display short help message and exit. .It Fl k Emulate .Xr apropos 1 . .It Fl m Ar arch Ns Op : Ns Ar machine Override the default architecture and machine settings allowing lookup of other platform specific manual pages. See .Sx IMPLEMENTATION NOTES for how this option changes the default behavior. Overrides the .Ev MACHINE_ARCH and .Ev MACHINE environment variables. .It Fl o Force use of non-localized manual pages. See .Sx IMPLEMENTATION NOTES for how locale specific searches work. Overrides the .Ev LC_ALL , LC_CTYPE , and .Ev LANG environment variables. .It Fl p Op Cm eprtv Use the list of given preprocessors before running .Xr nroff 1 or .Xr troff 1 . Valid preprocessors arguments: .Pp .Bl -tag -width indent -compact .It Cm e .Xr eqn 1 .It Cm p .Xr pic 1 .It Cm r .Xr refer 1 .It Cm t .Xr tbl 1 .It Cm v .Xr vgrind 1 .El .Pp Overrides the .Ev MANROFFSEQ environment variable. .It Fl t Send manual page source through .Xr troff 1 allowing transformation of the manual pages to other formats. .It Fl w Display the location of the manual page instead of the contents of the manual page. .El .Sh IMPLEMENTATION NOTES .Ss Locale Specific Searches The .Nm utility supports manual pages in different locales. The search behavior is dictated by the first of three environment variables with a nonempty string: .Ev LC_ALL , LC_CTYPE , or .Ev LANG . If set, .Nm will search for locale specific manual pages using the following logic: .Pp .Bl -item -offset indent -compact .It .Va lang Ns _ Ns Va country Ns . Ns Va charset .It .Va lang Ns . Ns Va charset .It .Li en Ns . Ns Va charset .El .Pp For example, if .Ev LC_ALL is set to .Dq Li ja_JP.eucJP , .Nm will search the following paths when considering section 1 manual pages in .Pa /usr/share/man : .Pp .Bl -item -offset indent -compact .It .Pa /usr/share/man/ja_JP.eucJP/man1 .It .Pa /usr/share/man/ja.eucJP/man1 .It .Pa /usr/share/man/en.eucJP/man1 .It .Pa /usr/share/man/man1 .El .Ss Platform Specific Searches The .Nm utility supports platform specific manual pages. The search behavior is dictated by the .Fl m option or the .Ev MACHINE_ARCH and .Ev MACHINE environment variables. For example, if .Ev MACHINE_ARCH is set to .Dq Li i386 and .Ev MACHINE is set to .Dq Li pc98 , .Nm will search the following paths when considering section 4 manual pages in .Pa /usr/share/man : .Pp .Bl -item -offset indent -compact .It .Pa /usr/share/man/man4/pc98 .It .Pa /usr/share/man/man4/i386 .It .Pa /usr/share/man/man4 .El .Ss Displaying Specific Manual Files The .Nm utility also supports displaying a specific manual page if passed a path to the file as long as it contains a .Ql / character. .Sh ENVIRONMENT The following environment variables affect the execution of .Nm : .Bl -tag -width ".Ev MANROFFSEQ" .It Ev LC_ALL , LC_CTYPE , LANG Used to find locale specific manual pages. Valid values can be found by running the .Xr locale 1 command. See .Sx IMPLEMENTATION NOTES for details. Influenced by the .Fl o option. .It Ev MACHINE_ARCH , MACHINE Used to find platform specific manual pages. If unset, the output of .Dq Li "sysctl hw.machine_arch" and .Dq Li "sysctl hw.machine" is used respectively. See .Sx IMPLEMENTATION NOTES for details. Corresponds to the .Fl m option. .It Ev MANPATH Used to find the location of the manual files. See .Xr manpath 1 for additional information. Corresponds to the .Fl M option. .It Ev MANROFFSEQ Used to determine the preprocessors for the manual source before running .Xr nroff 1 or .Xr troff 1 . If unset, defaults to .Xr tbl 1 . Corresponds to the .Fl p option. .It Ev MANSECT Restricts manual sections searched to the specified colon delimited list. Corresponds to the .Fl S option. .It Ev MANWIDTH If set to a numeric value, used as the width manpages should be displayed. Otherwise, if set to a special value .Dq Li tty , and output is to a terminal, the pages may be displayed over the whole width of the screen. .It Ev MANCOLOR If set, enables color support. .It Ev MANPAGER Program used to display files. .Pp If unset, and color support is enabled, .Dq Li "less -sR" is used. .Pp If unset, and color support is disabled, then .Ev PAGER is used. If that has no value either, .Dq Li "more -s" is used. .El .Sh FILES .Bl -tag -width indent -compact .It Pa /etc/man.conf System configuration file. .It Pa /usr/local/etc/man.d/*.conf Local configuration files. .El .Sh SEE ALSO .Xr apropos 1 , .Xr intro 1 , +.Xr locale 1 , +.Xr manpath 1 , +.Xr nroff 1 , +.Xr troff 1 , +.Xr whatis 1 , .Xr intro 2 , .Xr intro 3 , .Xr intro 4 , .Xr intro 5 , +.Xr man.conf 5 , .Xr intro 6 , .Xr intro 7 , .Xr intro 8 , -.Xr intro 9 , -.Xr locale 1 , -.Xr manpath 1 , -.Xr nroff 1 , -.Xr troff 1 , -.Xr whatis 1 , -.Xr man.conf 5 +.Xr intro 9 Index: head/usr.bin/mkcsmapper/mkcsmapper.1 =================================================================== --- head/usr.bin/mkcsmapper/mkcsmapper.1 (revision 276257) +++ head/usr.bin/mkcsmapper/mkcsmapper.1 (revision 276258) @@ -1,89 +1,89 @@ .\" Copyright (c) 2009 Gabor Kovesdan .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" Portions of this text are reprinted and reproduced in electronic form .\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- .\" Portable Operating System Interface (POSIX), The Open Group Base .\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of .\" Electrical and Electronics Engineers, Inc and The Open Group. In the .\" event of any discrepancy between this version and the original IEEE and .\" The Open Group Standard, the original IEEE and The Open Group Standard is .\" the referee document. The original Standard can be obtained online at .\" http://www.opengroup.org/unix/online.html. .\" .\" $FreeBSD$ .\" .Dd Sep 6, 2009 .Dt MKCSMAPPER 1 .Os .Sh NAME .Nm mkcsmapper .Nd generates hashed conversion data for .Xr iconv 3 .Sh SYNOPSIS .Nm .Op Fl mpd .Fl o .Ar outfile .Ar infile .Sh DESCRIPTION The .Nm utility generates binary conversion data from plain text conversion tables for the .Xr iconv 3 library. The conversion data has two components: The conversion mapping between specific character encodings. A pivot file, which the possible source and destination encoding pairs or the set of mappings to use for a compound encoding. .Pp The following options are available: .Bl -tag -width 0123 .It Fl d Turns on debug mode. .It Fl m Generate mapping data from .Ar infile . .It Fl o Ar outfile Put generated binary data to .Ar outfile . .It Fl p Generate pivot data from .Ar outfile . .El .Sh EXIT STATUS .Ex -std mkcsmapper .Sh SEE ALSO .Xr iconv 1 , -.Xr iconv 3 , -.Xr mkesdb 1 +.Xr mkesdb 1 , +.Xr iconv 3 .Sh HISTORY .Nm first appeared in .Nx 2.0 , and made its appearance in .Fx 9.0 . .Sh AUTHORS This manual page was written by .An Gabor Kovesdan Aq Mt gabor@FreeBSD.org . Index: head/usr.bin/mkesdb/mkesdb.1 =================================================================== --- head/usr.bin/mkesdb/mkesdb.1 (revision 276257) +++ head/usr.bin/mkesdb/mkesdb.1 (revision 276258) @@ -1,84 +1,84 @@ .\" Copyright (c) 2009 Gabor Kovesdan .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" Portions of this text are reprinted and reproduced in electronic form .\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- .\" Portable Operating System Interface (POSIX), The Open Group Base .\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of .\" Electrical and Electronics Engineers, Inc and The Open Group. In the .\" event of any discrepancy between this version and the original IEEE and .\" The Open Group Standard, the original IEEE and The Open Group Standard is .\" the referee document. The original Standard can be obtained online at .\" http://www.opengroup.org/unix/online.html. .\" .\" $FreeBSD$ .\" .Dd November 1, 2009 .Dt MKESDB 1 .Os .Sh NAME .Nm mkesdb .Nd generates conversion catalog for .Xr iconv 3 .Sh SYNOPSIS .Nm .Op Fl md .Fl o .Ar outfile .Ar infile .Sh DESCRIPTION The .Nm utility generates conversion catalog for the .Xr iconv 3 library. The generated data includes a list of supported encodings and their most important characteristics, like the pluggable module to use .Pp The following options are available: .Bl -tag -width 0123 .It Fl d Turns on debug mode. .It Fl m Process directory catalog or alias file. If not specified, the input file is treated as an encoding description. .It Fl o Ar outfile Put generated binary data to .Ar outfile . .El .Sh EXIT STATUS .Ex -std mkesdb .Sh SEE ALSO .Xr iconv 1 , -.Xr iconv 3 , -.Xr mkcsmapper 1 +.Xr mkcsmapper 1 , +.Xr iconv 3 .Sh HISTORY .Nm first appeared in .Nx 2.0 , and made its appearance in .Fx 9.0 . .Sh AUTHORS This manual page was written by .An Gabor Kovesdan Aq Mt gabor@FreeBSD.org . Index: head/usr.bin/rup/rup.1 =================================================================== --- head/usr.bin/rup/rup.1 (revision 276257) +++ head/usr.bin/rup/rup.1 (revision 276258) @@ -1,95 +1,95 @@ .\" -*- nroff -*- .\" .\" Copyright (c) 1985, 1991 The Regents of the University of California. .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd June 7, 1993 .Dt RUP 1 .Os .Sh NAME .Nm rup .Nd remote status display .Sh SYNOPSIS .Nm .Op Ar host ... .Sh DESCRIPTION The .Nm utility displays a summary of the current system status of a particular .Ar host or all hosts on the local network. The output shows the current time of day, how long the system has been up, and the load averages. The load average numbers give the number of jobs in the run queue averaged over 1, 5 and 15 minutes. .Pp The .Xr rpc.rstatd 8 daemon must be running on the remote host for this command to work. The .Nm utility uses an RPC protocol defined in .In rpcsvc/rstat.x . .Sh EXAMPLES .Bd -literal example% rup otherhost otherhost 7:36am up 6 days, 16:45, load average: 0.20, 0.23, 0.18 example% .Ed .Sh DIAGNOSTICS .Bl -diag .It rup: RPC: Program not registered The .Xr rpc.rstatd 8 daemon has not been started on the remote host. .It rup: RPC: Timed out A communication error occurred. Either the network is excessively congested, or the .Xr rpc.rstatd 8 daemon has terminated on the remote host. .It rup: RPC: Port mapper failure - RPC: Timed out The remote host is not running the portmapper (see .Xr rpcbind 8 ) , and cannot accommodate any RPC-based services. The host may be down. .El .Sh SEE ALSO -.Xr rpcbind 8 , -.Xr rpc.rstatd 8 +.Xr rpc.rstatd 8 , +.Xr rpcbind 8 .Sh HISTORY The .Nm command appeared in .Tn Sun-OS . .Sh BUGS The sorting options are not implemented. Index: head/usr.bin/rusers/rusers.1 =================================================================== --- head/usr.bin/rusers/rusers.1 (revision 276257) +++ head/usr.bin/rusers/rusers.1 (revision 276258) @@ -1,104 +1,104 @@ .\" Copyright (c) 1983, 1990 The Regents of the University of California. .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" from: @(#)rusers.1 6.7 (Berkeley) 4/23/91 .\" $FreeBSD$ .\" .Dd April 23, 1991 .Dt RUSERS 1 .Os .Sh NAME .Nm rusers .Nd who is logged in to machines on local network .Sh SYNOPSIS .Nm .Op Fl al .Op Ar host ... .Sh DESCRIPTION The .Nm command produces output similar to .Xr who 1 , but for the list of .Ar host Ns s or all machines on the local network. For each .Ar host responding to the .Nm query, the hostname with the names of the users currently logged on is printed on each line. The .Nm command will wait for one minute to catch late responders. .Pp The following options are available: .Bl -tag -width indent .It Fl a Print all machines responding even if no one is currently logged in. .It Fl l Print a long format listing. This includes the user name, host name, tty that the user is logged in to, the date and time the user logged in, the amount of time since the user typed on the keyboard, and the remote host they logged in from (if applicable). .El .Sh DIAGNOSTICS .Bl -diag .It rusers: RPC: Program not registered The .Xr rpc.rusersd 8 daemon has not been started on the remote host. .It rusers: RPC: Timed out A communication error occurred. Either the network is excessively congested, or the .Xr rpc.rusersd 8 daemon has terminated on the remote host. .It rusers: "RPC: Port mapper failure - RPC: Timed out" The remote host is not running the portmapper (see .Xr rpcbind 8 ) , and cannot accommodate any RPC-based services. The host may be down. .El .Sh SEE ALSO .Xr rwho 1 , .Xr users 1 , .Xr who 1 , -.Xr rpcbind 8 , -.Xr rpc.rusersd 8 +.Xr rpc.rusersd 8 , +.Xr rpcbind 8 .Sh HISTORY The .Nm command appeared in .Em Sun-OS . .Sh BUGS The sorting options are not implemented. Index: head/usr.bin/rwall/rwall.1 =================================================================== --- head/usr.bin/rwall/rwall.1 (revision 276257) +++ head/usr.bin/rwall/rwall.1 (revision 276258) @@ -1,79 +1,79 @@ .\" Copyright (c) 1983, 1990 The Regents of the University of California. .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" from: @(#)rwall.1 6.7 (Berkeley) 4/23/91 .\" $FreeBSD$ .\" .Dd April 23, 1991 .Dt RWALL 1 .Os .Sh NAME .Nm rwall .Nd send a message to users logged on a host .Sh SYNOPSIS .Nm .Ar host .Op Ar file .Sh DESCRIPTION The .Nm command sends a message to the users logged into the specified .Ar host . The message to be sent can be typed in and terminated with EOF or it can be in a .Ar file . .Sh DIAGNOSTICS .Bl -diag .It rwall: RPC: Program not registered The .Xr rpc.rwalld 8 daemon has not been started on the remote host. .It rwall: RPC: Timed out A communication error occurred. Either the network is excessively congested, or the .Xr rpc.rwalld 8 daemon has terminated on the remote host. .It rwall: RPC: Port mapper failure - RPC: Timed out The remote host is not running the portmapper (see .Xr rpcbind 8 ) , and cannot accommodate any RPC-based services. The host may be down. .El .Sh SEE ALSO .Xr who 1 , -.Xr rpcbind 8 , -.Xr rpc.rwalld 8 +.Xr rpc.rwalld 8 , +.Xr rpcbind 8 .Sh HISTORY The .Nm command appeared in .Em Sun-OS . .Sh BUGS The sorting options are not implemented. Index: head/usr.bin/script/script.1 =================================================================== --- head/usr.bin/script/script.1 (revision 276257) +++ head/usr.bin/script/script.1 (revision 276258) @@ -1,217 +1,217 @@ .\" Copyright (c) 1980, 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)script.1 8.1 (Berkeley) 6/6/93 .\" $FreeBSD$ .\" .Dd December 4, 2013 .Dt SCRIPT 1 .Os .Sh NAME .Nm script .Nd make typescript of terminal session .Sh SYNOPSIS .Nm .Op Fl adfkpqr .Op Fl F Ar pipe .Op Fl t Ar time .Op Ar file Op Ar command ... .Sh DESCRIPTION The .Nm utility makes a typescript of everything printed on your terminal. It is useful for students who need a hardcopy record of an interactive session as proof of an assignment, as the typescript file can be printed out later with .Xr lpr 1 . .Pp If the argument .Ar file is given, .Nm saves all dialogue in .Ar file . If no file name is given, the typescript is saved in the file .Pa typescript . .Pp If the argument .Ar command is given, .Nm will run the specified command with an optional argument vector instead of an interactive shell. .Pp The following options are available: .Bl -tag -width indent .It Fl a Append the output to .Ar file or .Pa typescript , retaining the prior contents. .It Fl d When playing back a session with the .Fl p flag, do not sleep between records when playing back a timestamped session. .It Fl F Ar pipe Immediately flush output after each write. This will allow a user to create a named pipe using .Xr mkfifo 1 and another user may watch the live session using a utility like .Xr cat 1 . .It Fl f Create .Ar file.filemon or .Pa typescript.filemon using .Xr filemon 4 . .It Fl k Log keys sent to the program as well as output. .It Fl p Play back a session recorded with the .Fl r flag in real time. .It Fl q Run in quiet mode, omit the start, stop and command status messages. .It Fl r Record a session with input, output, and timestamping. .It Fl t Ar time Specify the interval at which the script output file will be flushed to disk, in seconds. A value of 0 causes .Nm to flush after every character I/O event. The default interval is 30 seconds. .El .Pp The script ends when the forked shell (or command) exits (a .Em control-D to exit the Bourne shell .Pf ( Xr sh 1 ) , and .Em exit , .Em logout or .Em control-D (if .Em ignoreeof is not set) for the C-shell, .Xr csh 1 ) . .Pp Certain interactive commands, such as .Xr vi 1 , create garbage in the typescript file. The .Nm utility works best with commands that do not manipulate the screen. The results are meant to emulate a hardcopy terminal, not an addressable one. .Sh ENVIRONMENT The following environment variables are utilized by .Nm : .Bl -tag -width SHELL .It Ev SCRIPT The .Ev SCRIPT environment variable is added to the sub-shell. If .Ev SCRIPT already existed in the users environment, its value is overwritten within the sub-shell. The value of .Ev SCRIPT is the name of the .Ar typescript file. .It Ev SHELL If the variable .Ev SHELL exists, the shell forked by .Nm will be that shell. If .Ev SHELL is not set, the Bourne shell is assumed. .Pq Most shells set this variable automatically . .El .Sh SEE ALSO -.Xr csh 1 +.Xr csh 1 , .Xr filemon 4 .Po for the .Em history mechanism .Pc . .Sh HISTORY The .Nm command appeared in .Bx 3.0 . .Pp The .Fl d , .Fl p and .Fl r options first appeared in .Nx 2.0 and were ported to .Fx 9.2 . .Sh BUGS The .Nm utility places .Sy everything in the log file, including linefeeds and backspaces. This is not what the naive user expects. .Pp It is not possible to specify a command without also naming the script file because of argument parsing compatibility issues. .Pp When running in .Fl k mode, echo cancelling is far from ideal. The slave terminal mode is checked for ECHO mode to check when to avoid manual echo logging. This does not work when the terminal is in a raw mode where the program being run is doing manual echo. .Pp If .Nm reads zero bytes from the terminal, it switches to a mode when it only attempts to read once a second until there is data to read. This prevents .Nm from spinning on zero-byte reads, but might cause a 1-second delay in processing of user input. Index: head/usr.bin/setchannel/setchannel.1 =================================================================== --- head/usr.bin/setchannel/setchannel.1 (revision 276257) +++ head/usr.bin/setchannel/setchannel.1 (revision 276258) @@ -1,103 +1,103 @@ .\"- .\" Copyright (C) 2004-2006 The FreeBSD Project. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $Id: cxm.4,v 1.1 2004/10/16 00:12:35 mavetju Exp $ .\" $FreeBSD$ .\" .Dd November 30, 2006 .Dt PVR250-SETCHANNEL 1 .Os .Sh NAME .Nm pvr250-setchannel .Nd Hauppage PVR250/350 channel selector .Sh SYNOPSIS .Cd pvr250-setchannel [-a {on | off}] [-c | -r | -s | -t] [-g geom] [-m channel_set] [channel | freq] .Sh DESCRIPTION .Nm provides support for selecting channels on Hauppauge WinTV cards, including the PVR 150, PVR 250, PVR 350 and PVR 500. .Pp The following options are available: .Bl -tag -width indent .It Fl a Cm on Enable AFC. .It Fl a Cm off Disable AFC. .It Fl c Select composite input. .It Fl d Select the tuner unit number. This is appended to the base device file name .Pa /dev/cxm to form a device name such as .Pa /dev/cxm0 or .Pa /dev/cxm1 . .It Fl r Select radio input. .It Fl s Select svideo input. .It Fl t Select tuner. .It Fl g Cm geom Select geometry. The first resolution is for NTSC, the second for PAL. .Pp VCD: 352x240 or 352x288 SVCD: 480x480 or 480x576 DVD (half D1): 352x480 or 352x576 DVD (full D1): 720x480 or 720x576 .It Fl m Cm channel-set Select channel set and system. .Pp 0 = Tuner Default 1 = US Broadcast (NTSC) 2 = US Cable (NTSC) 4 = Western Europe (PAL) 5 = Japan Broadcast (NTSC) 6 = Japan Cable (NTSC) 8 = Australia (PAL) 9 = France (SECAM) .It Cm channel Channel number to set. .It Cm freq Frequency in MHz (must include decimal point). .El .Sh SEE ALSO -.Xr cxm 4 , .Xr bktr 4 , +.Xr cxm 4 , .Xr meteor 4 .Sh HISTORY The .Nm program first appeared in the -multimedia mailing-list in January 2004. The .Nm program first appeared in the FreeBSD Ports collection in October 2004. .Sh AUTHORS .An -nosplit This program is made by .An John Wehle .Pp This man page is made by .An Edwin Groothuis Index: head/usr.bin/showmount/showmount.8 =================================================================== --- head/usr.bin/showmount/showmount.8 (revision 276257) +++ head/usr.bin/showmount/showmount.8 (revision 276258) @@ -1,102 +1,102 @@ .\" Copyright (c) 1989, 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" This code is derived from software contributed to Berkeley by .\" Rick Macklem at The University of Guelph. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)showmount.8 8.3 (Berkeley) 3/29/95 .\" $FreeBSD$ .\" .Dd August 16, 2014 .Dt SHOWMOUNT 8 .Os .Sh NAME .Nm showmount .Nd show remote nfs mounts on host .Sh SYNOPSIS .Nm .Op Fl a | d .Op Fl e .Op Fl 1 .Op Fl 3 .Op Ar host .Sh DESCRIPTION The .Nm utility shows status information about the .Tn NFS server on .Ar host . By default it prints the names of all hosts that have .Tn NFS file systems mounted on the host. See .%T "NFS: Network File System Protocol Specification" , RFC 1094, Appendix A, and .%T "NFS: Network File System Version 3 Protocol Specification" , Appendix I, for a detailed description of the protocol. .Pp The following options are available: .Bl -tag -width indent .It Fl a List all mount points in the form: .Bd -ragged -offset indent -compact .Ar host : Ns Ar dirpath . .Ed .It Fl d List directory paths of mount points instead of hosts. .It Fl e Show the .Ar host Ns 's exports list. .It Fl 1 Use mount protocol Version 1, compatible with legacy servers. .It Fl 3 Ignored for backwards compatibility. .El .Sh SEE ALSO .Xr mount 8 , -.Xr mountd 8 , -.Xr mount_nfs 8 +.Xr mount_nfs 8 , +.Xr mountd 8 .Sh HISTORY The .Nm utility first appeared in .Bx 4.4 . .Sh BUGS The mount daemon running on the server only has an idea of the actual mounts, since the .Tn NFS server is stateless. The .Nm utility will only display the information as accurately as the mount daemon reports it. Index: head/usr.sbin/bluetooth/btpand/btpand.8 =================================================================== --- head/usr.sbin/bluetooth/btpand/btpand.8 (revision 276257) +++ head/usr.sbin/bluetooth/btpand/btpand.8 (revision 276258) @@ -1,240 +1,240 @@ .\" $NetBSD: btpand.8,v 1.3 2008/08/17 14:43:07 plunky Exp $ .\" $FreeBSD$ .\" .\" Copyright (c) 2008 Iain Hibbert .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" .Dd August 17, 2008 .Dt BTPAND 8 .Os .Sh NAME .Nm btpand .Nd Bluetooth PAN daemon .Sh SYNOPSIS .Nm .Op Fl i Ar ifname .Op Fl m Ar mode .Fl a Ar addr .Fl d Ar device .Brq Fl s Ar service | Fl S Ar service Op Fl p Ar psm .Nm .Op Fl c Ar path .Op Fl i Ar ifname .Op Fl l Ar limit .Op Fl m Ar mode .Op Fl p Ar psm .Fl d Ar device .Brq Fl s Ar service | Fl S Ar service .Sh DESCRIPTION The .Nm daemon handles Bluetooth Personal Area Networking services in the system. It can operate in client mode as a Personal Area Networking User .Pq PANU or in server mode as Network Access Point .Pq NAP , Group ad-hoc Network .Pq GN or PANU host. .Nm connects to the system via a .Xr tap 4 virtual Ethernet device and forwards Ethernet packets to remote Bluetooth devices using the Bluetooth Network Encapsulation Protocol .Pq BNEP . .Pp The PANU client is the device that uses either the NAP or GN service, or can talk directly to a PANU host in a crossover cable fashion. .Pp A GN host forwards Ethernet packets to each of the connected PAN users as needed but does not provide access to any additional networks. .Pp The NAP service provides some of the features of an Ethernet bridge, with the NAP host forwarding Ethernet packets between each of the connected PAN users, and a different network media. .Pp Note, the only differences between NAP and GN services as implemented by .Nm are in the SDP service record. The bridging of packets by the NAP must be configured separately. .Pp The options are as follows: .Bl -tag -width ".Fl a Ar address" .It Fl a Ar address In client mode, address of remote server. May be given as BDADDR or name, in which case .Nm will attempt to resolve the address via the .Xr bt_gethostbyname 3 call. .It Fl c Ar path In server mode, specify .Ar path to the .Xr sdpd 8 control socket. The default path is .Pa /var/run/sdp . .It Fl d Ar device Restrict connections to the local .Ar device . May be given as BDADDR or name, in which case .Nm will attempt to resolve the address via the .Xr bt_devaddr 3 call. .Nm will set the .Xr tap 4 interface physical address to the BDADDR of the Bluetooth radio. .It Fl i Ar ifname .Nm uses the .Xr tap 4 driver to create a new network interface for use. Use this option to select a specific .Xr tap 4 device interface which must already be created. .It Fl l Ar limit In server mode, limit the number of simultaneous connections. The default limit is 7 for NAP and GN servers, and 1 for a PANU server. .It Fl m Ar mode Set L2CAP connection link mode. Supported modes are: .Pp .Bl -tag -width 8n -compact .It auth require devices to be paired. .It encrypt auth, plus enable encryption. .It secure encryption, plus change of link key. .El .Pp NOT YET SUPPORTED. Use global device settings to set authentication and encryption. .It Fl p Ar psm Use an alternative L2CAP Protocol/Service Multiplexer .Pq PSM for server mode or client mode .Pq when not using Service Discovery . The default PSM for BNEP is 15 .Pq 0x000f . .It Fl s Ar service Name of .Ar service to provide or connect to, the following services are recognised: .Pp .Bl -tag -width 8n -compact .It GN Group ad-hoc Network. .It NAP Network Access Point. .It PANU Personal Area Networking User. .El .It Fl S Ar service As per .Fl s except that .Nm will not use SDP services for connection setup. .El .Pp When providing networking services, the Bluetooth PAN profile says that the .Sq Class of Device property of the bluetooth controller SHALL include Networking capability .Pq set bit 0x020000 . See .Xr hccontrol 8 for details. .Pp After .Nm has set up the client or server connection and opened the .Xr tap 4 interface, it will create a pid file and detach. .Sh FILES .Bl -tag -width "Pa /etc/bluetooth/hosts" -compact .It Pa /dev/tap .It Pa /etc/bluetooth/hosts .It Pa /var/run/sdp .It Pa /var/run/tap Ns Em N Ns No .pid .El .Sh EXIT STATUS .Ex -std .Sh EXAMPLES .Dl ifconfig tap1 create .Dl btpand -a host -d mydevice -s NAP -i tap1 .Dl dhclient tap1 .Pp Will create a connection to the NAP on .Ar host , and link that to the .Ar tap1 interface. .Pp .Dl btpand -d mydevice -s GN .Pp Will create a Group Network and register the GN service with the local SDP server. .Sh SEE ALSO .Xr bluetooth 3 , -.Xr tap 4 , .Xr bridge 4 , -.Xr hccontrol 8 , +.Xr tap 4 , .Xr dhclient 8 , +.Xr hccontrol 8 , .Xr ifconfig 8 , .Xr sdpd 8 .Pp The .Qq Personal Area Networking Profile and .Qq Bluetooth Network Encapsulation Protocol specifications are available at .Dl http://www.bluetooth.com/ .Sh AUTHORS .An Iain Hibbert .Sh BUGS There is no way to supply alternative values for the SDP record. .Pp There is no way to set net type or multicast address filters. .Pp .Nm does not do any address routing except to directly connected unicast addresses. All other packets are multicast. .Pp As .Nm uses the BDADDR of the Bluetooth radio as the physical address of the tap, only one instance can be run per radio. .Pp .Nm can only provide a single service. Index: head/usr.sbin/bsnmpd/modules/snmp_bridge/snmp_bridge.3 =================================================================== --- head/usr.sbin/bsnmpd/modules/snmp_bridge/snmp_bridge.3 (revision 276257) +++ head/usr.sbin/bsnmpd/modules/snmp_bridge/snmp_bridge.3 (revision 276258) @@ -1,119 +1,119 @@ .\"- .\" Copyright (C) 2006 Shteryana Shopova .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd August 6, 2007 .Dt SNMP_BRIDGE 3 .Os .Sh NAME .Nm snmp_bridge .Nd "bridge module for snmpd" .Sh LIBRARY .Pq begemotSnmpdModulePath."bridge" = "/usr/lib/snmp_bridge.so" .Sh DESCRIPTION The .Nm snmp_bridge module implements the BRIDGE-MIB as standardized in RFC 4188, the RSTP-MIB standardized in RFC4318 and a private BEGEMOT-BRIDGE-MIB, which allows management of multiple bridge interfaces. Most of the objects defined in the private BEGEMOT-BRIDGE-MIB are duplicates of the original objects defined by the standard BRIDGE-MIB, but the private MIB also defines additional objects which make the functionality of .Nm similar to .Xr ifconfig 8 for configuring bridge interfaces. Therefore one should consider adding write communities or loading the .Nm module on systems where security is crucial. .Sh IMPLEMENTATION NOTES The additional objects to configure a bridge are: .Bl -tag -width "XXXXXXXXX" .It Va begemotBridgeBaseStatus Bridge interfaces can be created and destroyed via this object. SNMP SET operations with the following values are allowed: .Bl -tag -width ".It Va createAndWait" .It Va createAndWait will attempt to create a bridge interface with the name given by the table index. .It Va createAndGo will attempt to create a bridge interface with the name given by the table index and set the status of the interface to "active/up". .It Va destroy will attempt to destroy the bridge interface. .El .It Va begemotBridgeBaseSpanEnabled A SNMP SET operation on this object is only successful if the corresponding port has not been added as member of the bridge interface on the system. .It Va begemotBridgeBasePortStatus SNMP SET operations with the following values are allowed: .Bl -tag -width ".It Va createAndWait" .It Va createAndWait will create a new row for the bridge member in the SNMP .Va begemotBridgeBasePortTable but will not try to commit the information to the system. .It Va active will attempt to commit the information to the system and will be successful only if a value for .Va begemotBridgeBaseSpanEnabled has been SET already. .It Va destroy will attempt to remove the interface from the system bridge interface. .El .It Va begemotBridgeBasePortPrivate This object controls a bridge interface flag called PRIVATE where any private port can not communicate with another private port. .El .Sh RESTRICTIONS Not all information in the MIBs is currently available in FreeBSD. The following variables carry no information: .Bl -tag -width "XXXXXXXXX" .It Va dot1dBasePortCircuit .It Va dot1dBasePortDelayExceededDiscards .It Va dot1dBasePortMtuExceededDiscards .It Va begemotBridgeBasePortDelayExceededDiscards .It Va begemotBridgeBasePortMtuExceededDiscards .El .Sh FILES .Bl -tag -width "XXXXXXXXX" .It Pa /usr/share/snmp/defs/bridge_tree.def The description of the MIB tree implemented by .Nm . .It Pa /usr/share/snmp/mibs/BRIDGE-MIB.txt This is the BRIDGE-MIB that is implemented by this module. .It Pa /usr/share/snmp/mibs/RSTP-MIB.txt This is the RSTP-MIB implemented by this module. .It Pa /usr/share/snmp/mibs/BEGEMOT-BRIDGE-MIB.txt This is the private BEGEMOT-BRIDGE-MIB that is implemented by this module. .El .Sh SEE ALSO .Xr bsnmpd 1 , .Xr gensnmptree 1 , +.Xr snmpmod 3 , .Xr if_bridge 4 , -.Xr ifconfig 8 , -.Xr snmpmod 3 +.Xr ifconfig 8 .Sh AUTHORS .An Shteryana Shopova Aq Mt syrinx@FreeBSD.org Index: head/usr.sbin/bsnmpd/modules/snmp_wlan/snmp_wlan.3 =================================================================== --- head/usr.sbin/bsnmpd/modules/snmp_wlan/snmp_wlan.3 (revision 276257) +++ head/usr.sbin/bsnmpd/modules/snmp_wlan/snmp_wlan.3 (revision 276258) @@ -1,160 +1,160 @@ .\"- .\" Copyright (C) 2010 The FreeBSD Foundation .\" All rights reserved. .\" .\" This documentation was written by Shteryana Sotirova Shopova under .\" sponsorship from the FreeBSD Foundation. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd June 28, 2010 .Dt SNMP_WLAN 3 .Os .Sh NAME .Nm snmp_wlan .Nd "wireless networking module for" .Xr bsnmpd 1 .Sh LIBRARY .Pq begemotSnmpdModulePath."wlan" = "/usr/lib/snmp_wlan.so" .Sh DESCRIPTION The .Nm snmp_wlan module implements a private BEGEMOT-WIRELESS-MIB, which allows management of virtual wireless interfaces. The MIB defines objects similar to the state data and configuration capabilities of .Xr ifconfig 8 for configuring virtual wireless interfaces. Therefore one should consider adding write communities or loading the .Nm module on systems where security is crucial. .Sh IMPLEMENTATION NOTES A short description of the Tables and interesting objects in the MIB follows. .Bl -tag -width "XXXXXXXXX" .It Va wlanInterfaceTable The table is used for creation and deletion of virtual wireless interfaces. To add a new interface, a SET should be executed on the .Va wlanIfaceName column with value the desired name of the interface. Next the parent interface must be set via .Va wlanParentIfName column. Any optional parameters may be set via the .Va wlanIfaceOperatingMode , .Va wlanIfaceFlags , .Va wlanIfaceBssid and .Va wlanIfaceLocalAddress columns. To finally create the interface in the system, a SET with value of active(1) to .Va wlanIfaceStatus column should be executed. To destroy a wireless interface a SET with value of destroy(6) to the relevant .Va wlanIfaceStatus column should be executed. .It Va wlanIfParentTable The table contains information about the hardware capabilities of the parent of a wireless interface. .It Va wlanIfaceConfigTable The table is used to get or set various configuration parameters for a virtual wireless interface. Depending on the operating mode of the interface and the hardware capabilities of the underlying hardware interface, not all parameters and values may be supported. .It Va wlanIfacePeerTable The table contains information about the associated stations for interfaces operating as access points, or the stations identified as neighbors in the IBSS for interfaces operating in adhoc mode. .It Va wlanIfaceChannelTable Information about the active channels for the wireless interfaces in the system. .It Va wlanIfRoamParamsTable The parameters that govern the roaming operation on the wireless interfaces. .It Va wlanIfTxParamsTable The parameters that govern the transmit operation on the wireless interfaces. .It Va wlanScanConfigTable The table that contains a configuration for channel scanning initiated via SNMP. .It Va wlanScanResultsTable The table contains the scan results from the last scan for each wireless interface on the system. .It Va wlanIfaceStatisticsTable Summary statistics for each wireless interface on the system. .It Va wlanWepInterfaceTable WEP configuration for the wireless interfaces on the system. .It Va wlanMACAccessControlTable Access Control configuration for wireless interfaces operating as access points. .It Va wlanMACAccessControlMACTable The table with Access Control MAC entries for which the configured Access Control Policy on wireless interfaces operating in Host AP mode is applied. .Va wlanMACAccessControlMACStatus column is used to add or delete MAC ACL entries. A set with value createAndGo(4) will add new entry, while with value destroy(6) will delete an existing one. .It Va wlanMeshRoutingConfig The subtree contains system configuration related to Wireless Mesh Routing. .It Va wlanMeshInterfaceTable The table contains information for wireless interfaces operating as wireless mesh points. .It Va wlanMeshNeighborTable The table contains information for the neighbors of wireless interfaces operating in mesh mode. .It Va wlanMeshRouteTable The mesh routing table for interfaces operating as mesh points, used for forwarding packets on a mesh network. .Va wlanMeshRouteStatus column is used to add or delete entries in the mesh routing table for an interface. A set with value createAndGo(4) will add new entry, while with value destroy(6) will delete an existing one. .It Va wlanMeshStatsTable Summary statistics for each virtual wireless interface operating as mesh point. .It Va wlanMeshHWMPConfig The subtree contains system configuration related to Hybrid Wireless Mesh Protocol. .It Va wlanHWMPInterfaceTable The table contains HWMP information for wireless interfaces operating in mesh mode. .It Va wlanMeshHWMPStatsTable Summary statistics for HWMP operation on interfaces operating as mesh points. .El .Sh RESTRICTIONS Not all information or configuration in the MIBs is currently available in FreeBSD. The values of the following variables carry no information: .Bl -tag -width "XXXXXXXXX" .It Va wlanStatsReset .El .Sh FILES .Bl -tag -width "XXXXXXXXX" .It Pa /usr/share/snmp/defs/wlan_tree.def The description of the MIB tree implemented by .Nm . .It Pa /usr/share/snmp/mibs/BEGEMOT-WIRELESS-MIB.txt The private BEGEMOT-WIRELESS-MIB that is implemented by this module. .El .Sh SEE ALSO .Xr bsnmpd 1 , .Xr gensnmptree 1 , +.Xr snmpmod 3 , .Xr wlan 4 , .Xr wlan_acl 4 , .Xr wlan_wep 4 , -.Xr ifconfig 8 , -.Xr snmpmod 3 +.Xr ifconfig 8 .Sh AUTHORS .An Shteryana Shopova Aq Mt syrinx@FreeBSD.org Index: head/usr.sbin/gpioctl/gpioctl.8 =================================================================== --- head/usr.sbin/gpioctl/gpioctl.8 (revision 276257) +++ head/usr.sbin/gpioctl/gpioctl.8 (revision 276258) @@ -1,124 +1,124 @@ .\" Copyright (c) 1980, 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd November 7, 2013 .Dt GPIOCTL 1 .Os .Sh NAME .Nm gpioctl .Nd GPIO control utility .Sh SYNOPSIS .Nm .Cm -l .Op Fl f Ar ctldev .Op Fl v .Nm .Cm -t .Op Fl f Ar ctldev .Ar pin .Nm .Cm -c .Op Fl f Ar ctldev .Ar pin .Ar flag .Op flag ... .Nm .Op Cm -f Ar ctldev .Ar pin .Ar [0|1] .Sh DESCRIPTION The .Nm utility could be used to manage GPIO pins from userland and list available pins. .Pp The options are as follows: .Bl -tag -width ".Fl f Ar ctldev" .It Fl c Ar pin Ar flag Op flag ... Configure pin by setting provided flags. The following flags are currently defined: .Bl -tag -offset indent -width ".Cm PULSE" .It Cm IN Input pin .It Cm OUT Output pin .It Cm OD Open drain pin .It Cm PP Push pull pin .It Cm TS Tristate pin .It Cm PU Pull-up pin .It Cm PD Pull-down pin .It Cm II Inverted input pin .It Cm IO Inverted output pin .El .It Fl f Ar ctldev GPIO controller device to use If not specified, defaults to .Pa /dev/gpioc0 .It Fl l list available pins .It Fl t Ar pin toggle value of provided pin number .It Fl v be verbose: for each listed pin print current configuration .El .Sh EXAMPLES .Bl -bullet .It List pins available on GPIO controller defined by device /dev/gpioc0 .Pp gpioctl -f /dev/gpioc0 -l .It Set the value of pin 12 to 1 .Pp gpioctl -f /dev/gpioc0 12 1 .It Configure pin 12 to be input pin .Pp gpioctl -f /dev/gpioc0 -c 12 IN .El .Sh SEE ALSO -.Xr gpio 4 -.Xr gpioiic 4 +.Xr gpio 4 , +.Xr gpioiic 4 , .Xr gpioled 4 .Sh HISTORY The .Nm utility appeared in .Fx 9.0 . .Sh AUTHORS .An -nosplit The .Nm utility and this manual page were written by .An Oleksandr Tymoshenko Aq Mt gonzo@freebsd.org . Index: head/usr.sbin/gssd/gssd.8 =================================================================== --- head/usr.sbin/gssd/gssd.8 (revision 276257) +++ head/usr.sbin/gssd/gssd.8 (revision 276258) @@ -1,119 +1,119 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd July 7, 2013 .Dt GSSD 8 .Os .Sh NAME .Nm gssd .Nd "Generic Security Services Daemon" .Sh SYNOPSIS .Nm .Op Fl d .Op Fl h .Op Fl o .Op Fl v .Op Fl s Ar dir-list .Op Fl c Ar file-substring .Op Fl r Ar preferred-realm .Sh DESCRIPTION The .Nm program provides support for the kernel GSS-API implementation. .Pp The options are as follows: .Bl -tag -width indent .It Fl d Run in debug mode. In this mode, .Nm will not fork when it starts. .It Fl h Enable support for host-based initiator credentials. This permits a kerberized NFS mount to use a service principal in the default Kerberos 5 keytab file for access. Such access is enabled via the gssname option for the .Xr mount_nfs 8 command. .It Fl o Force use of DES and the associated old style GSS-API initialization token. This may be required to make kerberized NFS mounts work against some non-FreeBSD NFS servers. .It Fl v Run in verbose mode. In this mode, .Nm will log activity messages to syslog using LOG_INFO | LOG_DAEMON or to stderr, if the .Fl d option has also been specified. The minor status is logged as a decimal number, since it is actually a Kerberos return status, which is signed. .It Fl s Ar dir-list Look for an appropriate credential cache file in this list of directories. The list should be full pathnames from root, separated by ':' characters. Usually this list will simply be "/tmp". Without this option, .Nm assumes that the credential cache file is called /tmp/krb5cc_, where is the effective uid for the RPC caller. .It Fl c Ar file-substring Set a file-substring for the credential cache file names. Only files with this substring embedded in their names will be selected as candidates when .Fl s has been specified. If not specified, it defaults to "krb5cc_". .It Fl r Ar preferred-realm Use Kerberos credentials for this realm when searching for credentials in directories specified with .Fl s . If not specified, the default Kerberos realm will be used. .El .Sh FILES .Bl -tag -width ".Pa /etc/krb5.keytab" -compact .It Pa /etc/krb5.keytab Contains Kerberos service principals which may be used as credentials by kernel GSS-API services. .El .Sh EXIT STATUS .Ex -std .Sh SEE ALSO .Xr gssapi 3 , -.Xr mount_nfs 8 , -.Xr syslog 3 +.Xr syslog 3 , +.Xr mount_nfs 8 .Sh HISTORY The .Nm manual page first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq Mt dfr@FreeBSD.org . Index: head/usr.sbin/jail/jail.8 =================================================================== --- head/usr.sbin/jail/jail.8 (revision 276257) +++ head/usr.sbin/jail/jail.8 (revision 276258) @@ -1,1265 +1,1265 @@ .\" Copyright (c) 2000, 2003 Robert N. M. Watson .\" Copyright (c) 2008-2012 James Gritton .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd August 4, 2014 .Dt JAIL 8 .Os .Sh NAME .Nm jail .Nd "manage system jails" .Sh SYNOPSIS .Nm .Op Fl dhilqv .Op Fl J Ar jid_file .Op Fl u Ar username .Op Fl U Ar username .Op Fl cmr .Ar param Ns = Ns Ar value ... .Op Cm command Ns = Ns Ar command ... .Nm .Op Fl dqv .Op Fl f Ar conf_file .Op Fl p Ar limit .Op Fl cmr .Op Ar jail .Nm .Op Fl qv .Op Fl f Ar conf_file .Op Fl rR .Op Cm * | Ar jail ... .Nm .Op Fl dhilqv .Op Fl J Ar jid_file .Op Fl u Ar username .Op Fl U Ar username .Op Fl n Ar jailname .Op Fl s Ar securelevel .Op Ar path hostname [ Ar ip Ns [ Ns Ar ,... Ns ]] Ar command ... .Sh DESCRIPTION The .Nm utility creates new jails, or modifies or removes existing jails. A jail .Pq or Dq prison is specified via parameters on the command line, or in the .Xr jail.conf 5 file. .Pp At least one of the options .Fl c , .Fl m or .Fl r must be specified. These options are used alone or in combination to describe the operation to perform: .Bl -tag -width indent .It Fl c Create a new jail. The jail .Va jid and .Va name parameters (if specified on the command line) must not refer to an existing jail. .It Fl m Modify an existing jail. One of the .Va jid or .Va name parameters must exist and refer to an existing jail. Some parameters may not be changed on a running jail. .It Fl r Remove the .Ar jail specified by jid or name. All jailed processes are killed, and all jails that are children of this jail are also removed. .It Fl rc Restart an existing jail. The jail is first removed and then re-created, as if .Dq Nm Fl r and .Dq Nm Fl c were run in succession. .It Fl cm Create a jail if it does not exist, or modify the jail if it does exist. .It Fl mr Modify an existing jail. The jail may be restarted if necessary to modify parameters than could not otherwise be changed. .It Fl cmr Create a jail if it doesn't exist, or modify (and possibly restart) the jail if it does exist. .El .Pp Other available options are: .Bl -tag -width indent .It Fl d Allow making changes to a dying jail, equivalent to the .Va allow.dying parameter. .It Fl f Ar conf_file Use configuration file .Ar conf_file instead of the default .Pa /etc/jail.conf . .It Fl h Resolve the .Va host.hostname parameter (or .Va hostname ) and add all IP addresses returned by the resolver to the list of addresses for this jail. This is equivalent to the .Va ip_hostname parameter. .It Fl i Output (only) the jail identifier of the newly created jail(s). This implies the .Fl q option. .It Fl J Ar jid_file Write a .Ar jid_file file, containing the parameters used to start the jail. .It Fl l Run commands in a clean environment. This is deprecated and is equivalent to the exec.clean parameter. .It Fl n Ar jailname Set the jail's name. This is deprecated and is equivalent to the .Va name parameter. .It Fl p Ar limit Limit the number of commands from .Va exec.* that can run simultaneously. .It Fl q Suppress the message printed whenever a jail is created, modified or removed. Only error messages will be printed. .It Fl R A variation of the .Fl r option that removes an existing jail without using the configuration file. No removal-related parameters for this jail will be used \(em the jail will simply be removed. .It Fl s Ar securelevel Set the .Va kern.securelevel MIB entry to the specified value inside the newly created jail. This is deprecated and is equivalent to the .Va securelevel parameter. .It Fl u Ar username The user name from host environment as whom jailed commands should run. This is deprecated and is equivalent to the .Va exec.jail_user and .Va exec.system_jail_user parameters. .It Fl U Ar username The user name from the jailed environment as whom jailed commands should run. This is deprecated and is equivalent to the .Va exec.jail_user parameter. .It Fl v Print a message on every operation, such as running commands and mounting filesystems. .El .Pp If no arguments are given after the options, the operation (except remove) will be performed on all jails specified in the .Xr jail.conf 5 file. A single argument of a jail name will operate only on the specified jail. The .Fl r and .Fl R options can also remove running jails that aren't in the .Xr jail.conf 5 file, specified by name or jid. .Pp An argument of .Dq * is a wildcard that will operate on all jails, regardless of whether they appear in .Xr jail.conf 5 ; this is the surest way for .Fl r to remove all jails. If hierarchical jails exist, a partial-matching wildcard definition may be specified. For example, an argument of .Dq foo.* would apply to jails with names like .Dq foo.bar and .Dq foo.bar.baz . .Pp A jail may be specified with parameters directly on the command line. In this case, the .Xr jail.conf 5 file will not be used. For backward compatibility, the command line may also have four fixed parameters, without names: .Ar path , .Ar hostname , .Ar ip , and .Ar command . This mode will always create a new jail, and the .Fl c and .Fl m options do not apply (and must not be present). .Ss Jail Parameters Parameters in the .Xr jail.conf 5 file, or on the command line, are generally of the form .Dq name=value . Some parameters are boolean, and do not have a value but are set by the name alone with or without a .Dq no prefix, e.g. .Va persist or .Va nopersist . They can also be given the values .Dq true and .Dq false . Other parameters may have more than one value, specified as a comma-separated list or with .Dq += in the configuration file (see .Xr jail.conf 5 for details). .Pp The .Nm utility recognizes two classes of parameters. There are the true jail parameters that are passed to the kernel when the jail is created, which can be seen with .Xr jls 8 , and can (usually) be changed with .Dq Nm Fl m . Then there are pseudo-parameters that are only used by .Nm itself. .Pp Jails have a set a core parameters, and kernel modules can add their own jail parameters. The current set of available parameters can be retrieved via .Dq Nm sysctl Fl d Va security.jail.param . Any parameters not set will be given default values, often based on the current environment. The core parameters are: .Bl -tag -width indent .It Va jid The jail identifier. This will be assigned automatically to a new jail (or can be explicitly set), and can be used to identify the jail for later modification, or for such commands as .Xr jls 8 or .Xr jexec 8 . .It Va name The jail name. This is an arbitrary string that identifies a jail (except it may not contain a .Sq \&. ) . Like the .Va jid , it can be passed to later .Nm commands, or to .Xr jls 8 or .Xr jexec 8 . If no .Va name is supplied, a default is assumed that is the same as the .Va jid . The .Va name parameter is implied by the .Xr jail.conf 5 file format, and need not be explicitly set when using the configuration file. .It Va path The directory which is to be the root of the jail. Any commands run inside the jail, either by .Nm or from .Xr jexec 8 , are run from this directory. .It Va ip4.addr A list of IPv4 addresses assigned to the jail. If this is set, the jail is restricted to using only these addresses. Any attempts to use other addresses fail, and attempts to use wildcard addresses silently use the jailed address instead. For IPv4 the first address given will be used as the source address when source address selection on unbound sockets cannot find a better match. It is only possible to start multiple jails with the same IP address if none of the jails has more than this single overlapping IP address assigned to itself. .It Va ip4.saddrsel A boolean option to change the formerly mentioned behaviour and disable IPv4 source address selection for the jail in favour of the primary IPv4 address of the jail. Source address selection is enabled by default for all jails and the .Va ip4.nosaddrsel setting of a parent jail is not inherited for any child jails. .It Va ip4 Control the availability of IPv4 addresses. Possible values are .Dq inherit to allow unrestricted access to all system addresses, .Dq new to restrict addresses via .Va ip4.addr , and .Dq disable to stop the jail from using IPv4 entirely. Setting the .Va ip4.addr parameter implies a value of .Dq new . .It Va ip6.addr , Va ip6.saddrsel , Va ip6 A set of IPv6 options for the jail, the counterparts to .Va ip4.addr , .Va ip4.saddrsel and .Va ip4 above. .It vnet Create the jail with its own virtual network stack, with its own network interfaces, addresses, routing table, etc. The kernel must have been compiled with the .Sy VIMAGE option for this to be available. Possible values are .Dq inherit to use the system network stack, possibly with restricted IP addresses, and .Dq new to create a new network stack. .It Va host.hostname The hostname of the jail. Other similar parameters are .Va host.domainname , .Va host.hostuuid and .Va host.hostid . .It Va host Set the origin of hostname and related information. Possible values are .Dq inherit to use the system information and .Dq new for the jail to use the information from the above fields. Setting any of the above fields implies a value of .Dq new . .It Va securelevel The value of the jail's .Va kern.securelevel sysctl. A jail never has a lower securelevel than its parent system, but by setting this parameter it may have a higher one. If the system securelevel is changed, any jail securelevels will be at least as secure. .It Va devfs_ruleset The number of the devfs ruleset that is enforced for mounting devfs in this jail. A value of zero (default) means no ruleset is enforced. Descendant jails inherit the parent jail's devfs ruleset enforcement. Mounting devfs inside a jail is possible only if the .Va allow.mount and .Va allow.mount.devfs permissions are effective and .Va enforce_statfs is set to a value lower than 2. Devfs rules and rulesets cannot be viewed or modified from inside a jail. .Pp NOTE: It is important that only appropriate device nodes in devfs be exposed to a jail; access to disk devices in the jail may permit processes in the jail to bypass the jail sandboxing by modifying files outside of the jail. See .Xr devfs 8 for information on how to use devfs rules to limit access to entries in the per-jail devfs. A simple devfs ruleset for jails is available as ruleset #4 in .Pa /etc/defaults/devfs.rules . .It Va children.max The number of child jails allowed to be created by this jail (or by other jails under this jail). This limit is zero by default, indicating the jail is not allowed to create child jails. See the .Sx "Hierarchical Jails" section for more information. .It Va children.cur The number of descendants of this jail, including its own child jails and any jails created under them. .It Va enforce_statfs This determines what information processes in a jail are able to get about mount points. It affects the behaviour of the following syscalls: .Xr statfs 2 , .Xr fstatfs 2 , .Xr getfsstat 2 , and .Xr fhstatfs 2 (as well as similar compatibility syscalls). When set to 0, all mount points are available without any restrictions. When set to 1, only mount points below the jail's chroot directory are visible. In addition to that, the path to the jail's chroot directory is removed from the front of their pathnames. When set to 2 (default), above syscalls can operate only on a mount-point where the jail's chroot directory is located. .It Va persist Setting this boolean parameter allows a jail to exist without any processes. Normally, a command is run as part of jail creation, and then the jail is destroyed as its last process exits. A new jail must have either the .Va persist parameter or .Va exec.start or .Va command pseudo-parameter set. .It Va cpuset.id The ID of the cpuset associated with this jail (read-only). .It Va dying This is true if the jail is in the process of shutting down (read-only). .It Va parent The .Va jid of the parent of this jail, or zero if this is a top-level jail (read-only). .It Va allow.* Some restrictions of the jail environment may be set on a per-jail basis. With the exception of .Va allow.set_hostname , these boolean parameters are off by default. .Bl -tag -width indent .It Va allow.set_hostname The jail's hostname may be changed via .Xr hostname 1 or .Xr sethostname 3 . .It Va allow.sysvipc A process within the jail has access to System V IPC primitives. In the current jail implementation, System V primitives share a single namespace across the host and jail environments, meaning that processes within a jail would be able to communicate with (and potentially interfere with) processes outside of the jail, and in other jails. .It Va allow.raw_sockets The jail root is allowed to create raw sockets. Setting this parameter allows utilities like .Xr ping 8 and .Xr traceroute 8 to operate inside the jail. If this is set, the source IP addresses are enforced to comply with the IP address bound to the jail, regardless of whether or not the .Dv IP_HDRINCL flag has been set on the socket. Since raw sockets can be used to configure and interact with various network subsystems, extra caution should be used where privileged access to jails is given out to untrusted parties. .It Va allow.chflags Normally, privileged users inside a jail are treated as unprivileged by .Xr chflags 2 . When this parameter is set, such users are treated as privileged, and may manipulate system file flags subject to the usual constraints on .Va kern.securelevel . .It Va allow.mount privileged users inside the jail will be able to mount and unmount file system types marked as jail-friendly. The .Xr lsvfs 1 command can be used to find file system types available for mount from within a jail. This permission is effective only if .Va enforce_statfs is set to a value lower than 2. .It Va allow.mount.devfs privileged users inside the jail will be able to mount and unmount the devfs file system. This permission is effective only together with .Va allow.mount and only when .Va enforce_statfs is set to a value lower than 2. The devfs ruleset should be restricted from the default by using the .Va devfs_ruleset option. .It Va allow.mount.nullfs privileged users inside the jail will be able to mount and unmount the nullfs file system. This permission is effective only together with .Va allow.mount and only when .Va enforce_statfs is set to a value lower than 2. .It Va allow.mount.procfs privileged users inside the jail will be able to mount and unmount the procfs file system. This permission is effective only together with .Va allow.mount and only when .Va enforce_statfs is set to a value lower than 2. .It Va allow.mount.tmpfs privileged users inside the jail will be able to mount and unmount the tmpfs file system. This permission is effective only together with .Va allow.mount and only when .Va enforce_statfs is set to a value lower than 2. .It Va allow.mount.zfs privileged users inside the jail will be able to mount and unmount the ZFS file system. This permission is effective only together with .Va allow.mount and only when .Va enforce_statfs is set to a value lower than 2. See .Xr zfs 8 for information on how to configure the ZFS filesystem to operate from within a jail. .It Va allow.quotas The jail root may administer quotas on the jail's filesystem(s). This includes filesystems that the jail may share with other jails or with non-jailed parts of the system. .It Va allow.socket_af Sockets within a jail are normally restricted to IPv4, IPv6, local (UNIX), and route. This allows access to other protocol stacks that have not had jail functionality added to them. .El .El .Pp There are pseudo-parameters that are not passed to the kernel, but are used by .Nm to set up the jail environment, often by running specified commands when jails are created or removed. The .Va exec.* command parameters are .Xr sh 1 command lines that are run in either the system or jail environment. They may be given multiple values, which run would the specified commands in sequence. All commands must succeed (return a zero exit status), or the jail will not be created or removed, as appropriate. .Pp The pseudo-parameters are: .Bl -tag -width indent .It Va exec.prestart Command(s) to run in the system environment before a jail is created. .It Va exec.start Command(s) to run in the jail environment when a jail is created. A typical command to run is .Dq sh /etc/rc . .It Va command A synonym for .Va exec.start for use when specifying a jail directly on the command line. Unlike other parameters whose value is a single string, .Va command uses the remainder of the .Nm command line as its own arguments. .It Va exec.poststart Command(s) to run in the system environment after a jail is created, and after any .Va exec.start commands have completed. .It Va exec.prestop Command(s) to run in the system environment before a jail is removed. .It Va exec.stop Command(s) to run in the jail environment before a jail is removed, and after any .Va exec.prestop commands have completed. A typical command to run is .Dq sh /etc/rc.shutdown . .It Va exec.poststop Command(s) to run in the system environment after a jail is removed. .It Va exec.clean Run commands in a clean environment. The environment is discarded except for .Ev HOME , SHELL , TERM and .Ev USER . .Ev HOME and .Ev SHELL are set to the target login's default values. .Ev USER is set to the target login. .Ev TERM is imported from the current environment. The environment variables from the login class capability database for the target login are also set. .It Va exec.jail_user The user to run commands as, when running in the jail environment. The default is to run the commands as the current user. .It Va exec.system_jail_user This boolean option looks for the .Va exec.jail_user in the system .Xr passwd 5 file, instead of in the jail's file. .It Va exec.system_user The user to run commands as, when running in the system environment. The default is to run the commands as the current user. .It Va exec.timeout The maximum amount of time to wait for a command to complete, in seconds. If a command is still running after this timeout has passed, the jail will not be created or removed, as appropriate. .It Va exec.consolelog A file to direct command output (stdout and stderr) to. .It Va exec.fib The FIB (routing table) to set when running commands inside the jail. .It Va stop.timeout The maximum amount of time to wait for a jail's processes to exit after sending them a .Dv SIGTERM signal (which happens after the .Va exec.stop commands have completed). After this many seconds have passed, the jail will be removed, which will kill any remaining processes. If this is set to zero, no .Dv SIGTERM is sent and the jail is immediately removed. The default is 10 seconds. .It Va interface A network interface to add the jail's IP addresses .Va ( ip4.addr and .Va ip6.addr ) to. An alias for each address will be added to the interface before the jail is created, and will be removed from the interface after the jail is removed. .It Va ip4.addr In addition to the IP addresses that are passed to the kernel, an interface, netmask and additional paramters (as supported by .Xr ifconfig 8 Ns ) may also be specified, in the form .Dq Ar interface Ns | Ns Ar ip-address Ns / Ns Ar netmask param ... . If an interface is given before the IP address, an alias for the address will be added to that interface, as it is with the .Va interface parameter. If a netmask in either dotted-quad or CIDR form is given after an IP address, it will be used when adding the IP alias. If additional parameters are specified then they will also be used when adding the IP alias. .It Va ip6.addr In addition to the IP addresses that are passed to the kernel, an interface, prefix and additional parameters (as supported by .Xr ifconfig 8 Ns ) may also be specified, in the form .Dq Ar interface Ns | Ns Ar ip-address Ns / Ns Ar prefix param ... . .It Va vnet.interface A network interface to give to a vnet-enabled jail after is it created. The interface will automatically be released when the jail is removed. .It Va ip_hostname Resolve the .Va host.hostname parameter and add all IP addresses returned by the resolver to the list of addresses .Po Va ip4.addr or .Va ip6.addr Pc for this jail. This may affect default address selection for outgoing IPv4 connections from jails. The address first returned by the resolver for each address family will be used as the primary address. .It Va mount A filesystem to mount before creating the jail (and to unmount after removing it), given as a single .Xr fstab 5 line. .It Va mount.fstab An .Xr fstab 5 format file containing filesystems to mount before creating a jail. .It Va mount.devfs Mount a .Xr devfs 5 filesystem on the chrooted .Pa /dev directory, and apply the ruleset in the .Va devfs_ruleset parameter (or a default of ruleset 4: devfsrules_jail) to restrict the devices visible inside the jail. .It Va mount.fdescfs Mount a .Xr fdescfs 5 filesystem on the chrooted .Pa /dev/fd directory. .It Va allow.dying Allow making changes to a .Va dying jail. .It Va depend Specify a jail (or jails) that this jail depends on. Any such jails must be fully created, up to the last .Va exec.poststart command, before any action will taken to create this jail. When jails are removed the opposite is true: this jail must be fully removed, up to the last .Va exec.poststop command, before the jail(s) it depends on are stopped. .El .Sh EXAMPLES Jails are typically set up using one of two philosophies: either to constrain a specific application (possibly running with privilege), or to create a .Dq "virtual system image" running a variety of daemons and services. In both cases, a fairly complete file system install of .Fx is required, so as to provide the necessary command line tools, daemons, libraries, application configuration files, etc. However, for a virtual server configuration, a fair amount of additional work is required so as to replace the .Dq boot process. This manual page documents the configuration steps necessary to support either of these steps, although the configuration steps may need to be refined based on local requirements. .Ss "Setting up a Jail Directory Tree" To set up a jail directory tree containing an entire .Fx distribution, the following .Xr sh 1 command script can be used: .Bd -literal D=/here/is/the/jail cd /usr/src mkdir -p $D make world DESTDIR=$D make distribution DESTDIR=$D .Ed .Pp In many cases this example would put far more in the jail than needed. In the other extreme case a jail might contain only one file: the executable to be run in the jail. .Pp We recommend experimentation, and caution that it is a lot easier to start with a .Dq fat jail and remove things until it stops working, than it is to start with a .Dq thin jail and add things until it works. .Ss "Setting Up a Jail" Do what was described in .Sx "Setting Up a Jail Directory Tree" to build the jail directory tree. For the sake of this example, we will assume you built it in .Pa /data/jail/testjail , for a jail named .Dq testjail . Substitute below as needed with your own directory, IP address, and hostname. .Ss "Setting up the Host Environment" First, set up the real system's environment to be .Dq jail-friendly . For consistency, we will refer to the parent box as the .Dq "host environment" , and to the jailed virtual machine as the .Dq "jail environment" . Since jails are implemented using IP aliases, one of the first things to do is to disable IP services on the host system that listen on all local IP addresses for a service. If a network service is present in the host environment that binds all available IP addresses rather than specific IP addresses, it may service requests sent to jail IP addresses if the jail did not bind the port. This means changing .Xr inetd 8 to only listen on the appropriate IP address, and so forth. Add the following to .Pa /etc/rc.conf in the host environment: .Bd -literal -offset indent sendmail_enable="NO" inetd_flags="-wW -a 192.0.2.23" rpcbind_enable="NO" .Ed .Pp .Li 192.0.2.23 is the native IP address for the host system, in this example. Daemons that run out of .Xr inetd 8 can be easily configured to use only the specified host IP address. Other daemons will need to be manually configured \(em for some this is possible through .Xr rc.conf 5 flags entries; for others it is necessary to modify per-application configuration files, or to recompile the application. The following frequently deployed services must have their individual configuration files modified to limit the application to listening to a specific IP address: .Pp To configure .Xr sshd 8 , it is necessary to modify .Pa /etc/ssh/sshd_config . .Pp To configure .Xr sendmail 8 , it is necessary to modify .Pa /etc/mail/sendmail.cf . .Pp For .Xr named 8 , it is necessary to modify .Pa /etc/namedb/named.conf . .Pp In addition, a number of services must be recompiled in order to run them in the host environment. This includes most applications providing services using .Xr rpc 3 , such as .Xr rpcbind 8 , .Xr nfsd 8 , and .Xr mountd 8 . In general, applications for which it is not possible to specify which IP address to bind should not be run in the host environment unless they should also service requests sent to jail IP addresses. Attempting to serve NFS from the host environment may also cause confusion, and cannot be easily reconfigured to use only specific IPs, as some NFS services are hosted directly from the kernel. Any third-party network software running in the host environment should also be checked and configured so that it does not bind all IP addresses, which would result in those services also appearing to be offered by the jail environments. .Pp Once these daemons have been disabled or fixed in the host environment, it is best to reboot so that all daemons are in a known state, to reduce the potential for confusion later (such as finding that when you send mail to a jail, and its sendmail is down, the mail is delivered to the host, etc.). .Ss "Configuring the Jail" Start any jail for the first time without configuring the network interface so that you can clean it up a little and set up accounts. As with any machine (virtual or not), you will need to set a root password, time zone, etc. Some of these steps apply only if you intend to run a full virtual server inside the jail; others apply both for constraining a particular application or for running a virtual server. .Pp Start a shell in the jail: .Bd -literal -offset indent jail -c path=/data/jail/testjail mount.devfs \\ host.hostname=testhostname ip4.addr=192.0.2.100 \\ command=/bin/sh .Ed .Pp Assuming no errors, you will end up with a shell prompt within the jail. You can now run .Pa /usr/sbin/sysinstall and do the post-install configuration to set various configuration options, or perform these actions manually by editing .Pa /etc/rc.conf , etc. .Pp .Bl -bullet -offset indent -compact .It Configure .Pa /etc/resolv.conf so that name resolution within the jail will work correctly. .It Run .Xr newaliases 1 to quell .Xr sendmail 8 warnings. .It Set a root password, probably different from the real host system. .It Set the timezone. .It Add accounts for users in the jail environment. .It Install any packages the environment requires. .El .Pp You may also want to perform any package-specific configuration (web servers, SSH servers, etc), patch up .Pa /etc/syslog.conf so it logs as you would like, etc. If you are not using a virtual server, you may wish to modify .Xr syslogd 8 in the host environment to listen on the syslog socket in the jail environment; in this example, the syslog socket would be stored in .Pa /data/jail/testjail/var/run/log . .Pp Exit from the shell, and the jail will be shut down. .Ss "Starting the Jail" You are now ready to restart the jail and bring up the environment with all of its daemons and other programs. Create an entry for the jail in .Pa /etc/jail.conf : .Bd -literal -offset indent testjail { path = /tmp/jail/testjail; mount.devfs; host.hostname = testhostname; ip4.addr = 192.0.2.100; interface = ed0; exec.start = "/bin/sh /etc/rc"; exec.stop = "/bin/sh /etc/rc.shutdown"; } .Ed .Pp To start a virtual server environment, .Pa /etc/rc is run to launch various daemons and services, and .Pa /etc/rc.shutdown is run to shut them down when the jail is removed. If you are running a single application in the jail, substitute the command used to start the application for .Dq /bin/sh /etc/rc ; there may be some script available to cleanly shut down the application, or it may be sufficient to go without a stop command, and have .Nm send .Dv SIGTERM to the application. .Pp Start the jail by running: .Bd -literal -offset indent jail -c testjail .Ed .Pp A few warnings may be produced; however, it should all work properly. You should be able to see .Xr inetd 8 , .Xr syslogd 8 , and other processes running within the jail using .Xr ps 1 , with the .Ql J flag appearing beside jailed processes. To see an active list of jails, use .Xr jls 8 . If .Xr sshd 8 is enabled in the jail environment, you should be able to .Xr ssh 1 to the hostname or IP address of the jailed environment, and log in using the accounts you created previously. .Pp It is possible to have jails started at boot time. Please refer to the .Dq jail_* variables in .Xr rc.conf 5 for more information. .Ss "Managing the Jail" Normal machine shutdown commands, such as .Xr halt 8 , .Xr reboot 8 , and .Xr shutdown 8 , cannot be used successfully within the jail. To kill all processes from within a jail, you may use one of the following commands, depending on what you want to accomplish: .Bd -literal -offset indent kill -TERM -1 kill -KILL -1 .Ed .Pp This will send the .Dv SIGTERM or .Dv SIGKILL signals to all processes in the jail \(em be careful not to run this from the host environment! Once all of the jail's processes have died, unless the jail was created with the .Va persist parameter, the jail will be removed. Depending on the intended use of the jail, you may also want to run .Pa /etc/rc.shutdown from within the jail. .Pp To shut down the jail from the outside, simply remove it with .Nm .Ar -r , which will run any commands specified by .Va exec.stop , and then send .Dv SIGTERM and eventually .Dv SIGKILL to any remaining jailed processes. .Pp The .Pa /proc/ Ns Ar pid Ns Pa /status file contains, as its last field, the name of the jail in which the process runs, or .Dq Li - to indicate that the process is not running within a jail. The .Xr ps 1 command also shows a .Ql J flag for processes in a jail. .Pp You can also list/kill processes based on their jail ID. To show processes and their jail ID, use the following command: .Pp .Dl "ps ax -o pid,jid,args" .Pp To show and then kill processes in jail number 3 use the following commands: .Bd -literal -offset indent pgrep -lfj 3 pkill -j 3 .Ed or: .Pp .Dl "killall -j 3" .Ss "Jails and File Systems" It is not possible to .Xr mount 8 or .Xr umount 8 any file system inside a jail unless the file system is marked jail-friendly, the jail's .Va allow.mount parameter is set, and the jail's .Va enforce_statfs parameter is lower than 2. .Pp Multiple jails sharing the same file system can influence each other. For example, a user in one jail can fill the file system, leaving no space for processes in the other jail. Trying to use .Xr quota 1 to prevent this will not work either, as the file system quotas are not aware of jails but only look at the user and group IDs. This means the same user ID in two jails share a single file system quota. One would need to use one file system per jail to make this work. .Ss "Sysctl MIB Entries" The read-only entry .Va security.jail.jailed can be used to determine if a process is running inside a jail (value is one) or not (value is zero). .Pp The variable .Va security.jail.max_af_ips determines how may address per address family a jail may have. The default is 255. .Pp Some MIB variables have per-jail settings. Changes to these variables by a jailed process do not affect the host environment, only the jail environment. These variables are .Va kern.securelevel , .Va kern.hostname , .Va kern.domainname , .Va kern.hostid , and .Va kern.hostuuid . .Ss "Hierarchical Jails" By setting a jail's .Va children.max parameter, processes within a jail may be able to create jails of their own. These child jails are kept in a hierarchy, with jails only able to see and/or modify the jails they created (or those jails' children). Each jail has a read-only .Va parent parameter, containing the .Va jid of the jail that created it; a .Va jid of 0 indicates the jail is a child of the current jail (or is a top-level jail if the current process isn't jailed). .Pp Jailed processes are not allowed to confer greater permissions than they themselves are given, e.g., if a jail is created with .Va allow.nomount , it is not able to create a jail with .Va allow.mount set. Similarly, such restrictions as .Va ip4.addr and .Va securelevel may not be bypassed in child jails. .Pp A child jail may in turn create its own child jails if its own .Va children.max parameter is set (remember it is zero by default). These jails are visible to and can be modified by their parent and all ancestors. .Pp Jail names reflect this hierarchy, with a full name being an MIB-type string separated by dots. For example, if a base system process creates a jail .Dq foo , and a process under that jail creates another jail .Dq bar , then the second jail will be seen as .Dq foo.bar in the base system (though it is only seen as .Dq bar to any processes inside jail .Dq foo ) . Jids on the other hand exist in a single space, and each jail must have a unique jid. .Pp Like the names, a child jail's .Va path appears relative to its creator's own .Va path . This is by virtue of the child jail being created in the chrooted environment of the first jail. .Sh SEE ALSO .Xr killall 1 , .Xr lsvfs 1 , .Xr newaliases 1 , .Xr pgrep 1 , .Xr pkill 1 , .Xr ps 1 , .Xr quota 1 , -.Xr ifconfig 8 , .Xr jail_set 2 , .Xr devfs 5 , .Xr fdescfs 5 , .Xr jail.conf 5 , .Xr procfs 5 , .Xr rc.conf 5 , .Xr sysctl.conf 5 , .Xr chroot 8 , .Xr devfs 8 , .Xr halt 8 , +.Xr ifconfig 8 , .Xr inetd 8 , .Xr jexec 8 , .Xr jls 8 , .Xr mount 8 , .Xr named 8 , .Xr reboot 8 , .Xr rpcbind 8 , .Xr sendmail 8 , .Xr shutdown 8 , .Xr sysctl 8 , .Xr syslogd 8 , .Xr umount 8 .Sh HISTORY The .Nm utility appeared in .Fx 4.0 . Hierarchical/extensible jails were introduced in .Fx 8.0 . The configuration file was introduced in .Fx 9.1 . .Sh AUTHORS .An -nosplit The jail feature was written by .An Poul-Henning Kamp for R&D Associates .Pa http://www.rndassociates.com/ who contributed it to .Fx . .Pp .An Robert Watson wrote the extended documentation, found a few bugs, added a few new features, and cleaned up the userland jail environment. .Pp .An Bjoern A. Zeeb added multi-IP jail support for IPv4 and IPv6 based on a patch originally done by .An Pawel Jakub Dawidek for IPv4. .Pp .An James Gritton added the extensible jail parameters, hierarchical jails, and the configuration file. .Sh BUGS It might be a good idea to add an address alias flag such that daemons listening on all IPs .Pq Dv INADDR_ANY will not bind on that address, which would facilitate building a safe host environment such that host daemons do not impose on services offered from within jails. Currently, the simplest answer is to minimize services offered on the host, possibly limiting it to services offered from .Xr inetd 8 which is easily configurable. .Sh NOTES Great care should be taken when managing directories visible within the jail. For example, if a jailed process has its current working directory set to a directory that is moved out of the jail's chroot, then the process may gain access to the file space outside of the jail. It is recommended that directories always be copied, rather than moved, out of a jail. .Pp In addition, there are several ways in which an unprivileged user outside the jail can cooperate with a privileged user inside the jail and thereby obtain elevated privileges in the host environment. Most of these attacks can be mitigated by ensuring that the jail root is not accessible to unprivileged users in the host environment. Regardless, as a general rule, untrusted users with privileged access to a jail should not be given access to the host environment. Index: head/usr.sbin/nandsim/nandsim.8 =================================================================== --- head/usr.sbin/nandsim/nandsim.8 (revision 276257) +++ head/usr.sbin/nandsim/nandsim.8 (revision 276258) @@ -1,229 +1,229 @@ .\" Copyright (c) 2010 Semihalf .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd August 10, 2010 .Dt NANDSIM 8 .Os .Sh NAME .Nm nandsim .Nd NAND simulator control program .Sh SYNOPSIS .Nm .Ic status .Aq ctrl_no | Fl -all | Fl a .Op Fl v .Nm .Ic conf .Aq filename .Nm .Ic start .Aq ctrl_no .Nm .Ic mod .Aq ctrl_no:cs_no | Fl l Aq loglevel .Op Fl p Aq prog_time .Op Fl e Aq erase_time .Op Fl r Aq read_time .Op Fl E Aq error_ratio .Op Fl h .Nm .Ic stop .Aq ctrl_no .Nm .Ic error .Aq ctrl_no:cs_no .Aq page_num .Aq column .Aq length .Aq pattern .Nm .Ic bb .Aq ctrl_no:cs_no .Op blk_num,blk_num2,... .Op Fl U .Op Fl L .Nm .Ic freeze .Op ctrl_no .Nm .Ic log .Aq ctrl_no | Fl -all | Fl a .Nm .Ic stats .Aq ctrl_no:cs_no .Aq page_num .Nm .Ic dump .Aq ctrl_no:cs_no .Aq filename .Nm .Ic restore .Aq ctrl_no:chip_no .Aq filename .Nm .Ic destroy .Aq ctrl_no[:cs_no] | Fl -all | Fl a .Nm .Ic help .Op Fl v .Sh COMMAND DESCRIPTION Controllers and chips are arranged into a simple hierarchy. There can be up to 4 controllers configured, each with 4 chip select (CS) lines. A given chip is connected to one of the chip selects. .Pp Controllers are specified as .Aq ctrl_no ; chip selects are specified as .Aq cs_no . .Bl -tag -width periphlist .It Ic status Gets controller(s) status. If .Fl a or .Fl -all flag is specified - command will print status of every controller currently available. Optional flag .Fl v causes printing complete information about the controller, and all chips attached to it. .It Ic conf Reads simulator configuration from a specified file (this includes the simulation "layout" i.e. controllers-chips assignments). Configuration changes for an already started simulation require a full stop-start cycle in order to take effect i.e.: .Bl -column .It nandsim stop ... .It nandsim destroy ... .Pp .It << edit config file >> .Pp .It nandsim conf ... .It nandsim start ... .El .It Ic mod Alters simulator parameters on-the-fly. If controller number and CS pair is not specified, the general simulator parameters (not specific to a controller or a chip) will be modified. Changing chip's parameters requires specifying both controller number and CS to which the given chip is connected. Parameters which can be altered: .Pp General simulator related: .Bl -tag -width flag .It Fl l Aq log_level change logging level to .Aq log_level .El .Pp Chip related: .Bl -tag -width flag .It Fl p Aq prog_time change prog time for specified chip to .Aq prog_time .It Fl e Aq erase_time change erase time for specified chip to .Aq erase_time .It Fl r Aq read_time change read time for specified chip to .Aq read_time .It Fl E Aq error_ratio change error ratio for specified chip to .Aq error_ratio . Error ratio is a number of errors per million read/write bytes. .El .Pp Additionally, flag .Fl h will list parameters which can be altered. .El .Bl -tag -width periphlist .It Ic bb Marks/unmarks a specified block as bad. To mark/unmark the bad condition an a block, the following parameters have to be supplied: controller number, CS number, and at least one block number. It is possible to specify multiple blocks, by separating blocks numbers with a comma. The following options can be used for the 'bb' command: .Bl -tag -width flag .It Fl U unmark the bad previously marked block as bad. .It Fl L list all blocks marked as bad on a given chip. .El .It Ic log Prints activity log of the specified controller to stdout; if controller number is not specifed, logs for all available controllers are printed. .It Ic stats Print statistics of the selected controller, chip and page. Statistics includes read count, write count, raw read count, raw write count, ECC stats (succeeded corrections, failed correction). .It Ic dump Dumps a snaphot of a single chip (including data and bad blocks information, wearout level) into the file. .It Ic restore Restores chip state from a dump-file snapshot (produced previously with the 'dump' command). .It Ic start Starts a controller i.e. the simulation. .It Ic stop Stops an already started controller; if the controller number is not supplied, attempts to stop all currently working controllers. .It Ic destroy Removes existing active chip/controller and its configuration from memory and releases the resources. Specifying flag .Fl a or .Fl -all causes removal of every chip and controller. Controller must be stopped in order to be destroyed. .It Ic error Directly overwrites a certain number of bytes in the specified page at a given offset with a supplied pattern (which mimics the corruption of flash contents). .It Ic help Prints synopsis, .Fl v gives more verbose output. .It Ic freeze Stops simulation of given controller (simulates power-loss). All commands issues to any chip on this controller are ignored. .El .Sh SEE ALSO .Xr nand 4 , -.Xr nandsim 4 +.Xr nandsim 4 , .Xr nandsim.conf 5 .Sh HISTORY The .Nm utility first appeared in .Fx 10.0 . .Sh AUTHORS This utility was written by .An Lukasz Wojcik . Index: head/usr.sbin/nfsuserd/nfsuserd.8 =================================================================== --- head/usr.sbin/nfsuserd/nfsuserd.8 (revision 276257) +++ head/usr.sbin/nfsuserd/nfsuserd.8 (revision 276258) @@ -1,114 +1,114 @@ .\" Copyright (c) 2009 Rick Macklem, University of Guelph .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd April 25, 2009 .Dt NFSUSERD 8 .Os .Sh NAME .Nm nfsuserd .Nd load user and group information into the kernel for .Tn NFSv4 services .Sh SYNOPSIS .Nm nfsuserd .Op Fl domain Ar domain_name .Op Fl usertimeout Ar minutes .Op Fl usermax Ar max_cache_size .Op Fl verbose .Op Fl force .Op Ar num_servers .Sh DESCRIPTION .Nm loads user and group information into the kernel for NFSv4. It must be running for NFSv4 to function correctly, either client or server. .Pp Upon startup, it loads the machines DNS domain name, plus timeout and cache size limit into the kernel. It then preloads the cache with group and user information, up to the cache size limit and forks off N children (default 4), that service requests from the kernel for cache misses. The master server is there for the sole purpose of killing off the slaves. To stop the nfsuserd, send a SIGUSR1 to the master server. .Pp The following options are available: .Bl -tag -width Ds .It Fl domain Ar domain_name This option allows you to override the default DNS domain name, which is acquired by taking either the suffix on the machine's hostname or, if that name is not a fully qualified host name, the canonical name as reported by .Xr getaddrinfo 3 . .It Fl usertimeout Ar minutes Overrides the default timeout for cache entries, in minutes. If the timeout is specified as 0, cache entries never time out. The longer the time out, the better the performance, but the longer it takes for replaced entries to be seen. If your user/group database management system almost never re-uses the same names or id numbers, a large timeout is recommended. The default is 1 minute. .It Fl usermax Ar max_cache_size Overrides the default upper bound on the cache size. The larger the cache, the more kernel memory is used, but the better the performance. If your system can afford the memory use, make this the sum of the number of entries in your group and password databases. The default is 200 entries. .It Fl verbose When set, the server logs a bunch of information to syslog. .It Fl force This flag option must be set to restart the daemon after it has gone away abnormally and refuses to start, because it thinks nfsuserd is already running. .It Ar num_servers Specifies how many servers to create (max 20). The default of 4 may be sufficient. You should run enough servers, so that .Xr ps 1 shows almost no running time for one or two of the slaves after the system has been running for a long period. Running too few will have a major performance impact, whereas running too many will only tie up some resources, such as a process table entry and swap space. .El .Sh SEE ALSO -.Xr getpwent 3 , .Xr getgrent 3 , +.Xr getpwent 3 , .Xr nfsv4 4 , .Xr group 5 , .Xr passwd 5 , -.Xr nfsd 8 . +.Xr nfsd 8 .Sh HISTORY The .Nm utility was introduced with the NFSv4 experimental subsystem in 2009. .Sh BUGS The .Nm use .Xr getgrent 3 and .Xr getpwent 3 library calls to resolve requests and will hang if the servers handling those requests fail and the library functions don't return. See .Xr group 5 and .Xr passwd 5 for more information on how the databases are accessed. Index: head/usr.sbin/rpc.umntall/rpc.umntall.8 =================================================================== --- head/usr.sbin/rpc.umntall/rpc.umntall.8 (revision 276257) +++ head/usr.sbin/rpc.umntall/rpc.umntall.8 (revision 276258) @@ -1,126 +1,126 @@ .\" .\" Copyright (c) 1999 Martin Blapp .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd November 17, 1999 .Dt RPC.UMNTALL 8 .Os .Sh NAME .Nm rpc.umntall .Nd notify NFS servers about unmounted NFS file systems .Sh SYNOPSIS .Nm .Op Fl e Ar expire .Op Fl h Ar host .Op Fl k .Op Fl p Ar remotepath .Op Fl v .Sh DESCRIPTION The .Nm utility is proposed in the .Tn NFS RPC specification; see .Rs .%T "NFS Version 3 Protocol Specification" .%O "RFC 1813, Appendix I" .Re It uses remote procedure calls to remove mount entries from .Pa /var/db/mountdtab on the remote NFS server. It is called automatically without any parameters during startup and shutdown of the system. This ensures that .Xr showmount 8 does not display old and expired entries. The .Nm utility is only needed on client side, where .Xr mount_nfs 8 adds a mount entry with the current date to .Pa /var/db/mounttab , and .Xr umount 8 removes the entry again. The .Nm utility cares about all remaining entries in this table which result from crashes or unproper shutdowns. .Pp The options are as follows: .Bl -tag -width indentxxx .It Fl e Ar expire All entries which are not actually mounted or older than .Ar expire (seconds) are removed from .Pa /var/db/mounttab . This may be the case for DNS changes or long out of service periods. Default expire time is 86400 seconds (one day). .It Fl h Ar host Only remove the specific hostname. Send a UMNTALL RPC to the NFS server. .It Fl k Keep entries for existing NFS file systems. Compare the NFS file systems from the mounttab against the kernel mountlist and do not send the RPC to existing mount entries. Useful during startup of the system. It may be possible that there are already mounted NFS file systems, so calling RPC UMOUNT is not a good idea. This is the case if the user has rebooted to 'single user mode' and starts up the system again. .It Fl p Ar path Only remove the specific mount-path. Send a UMOUNT RPC to the NFS server. This option implies the .Fl host option. .It Fl v Verbose, additional information is printed for each processed mounttab entry. .El .Sh FILES .Bl -tag -width /var/db/mounttab -compact .It Pa /var/db/mounttab mounted nfs-file systems .El .Sh SEE ALSO -.Xr mountd 8 , .Xr mount_nfs 8 , +.Xr mountd 8 , .Xr umount 8 .Sh HISTORY The .Nm utility first appeared in .Fx 4.0 . .Sh AUTHORS .An Martin Blapp Aq Mt mb@imp.ch Index: head/usr.sbin/rtadvctl/rtadvctl.8 =================================================================== --- head/usr.sbin/rtadvctl/rtadvctl.8 (revision 276257) +++ head/usr.sbin/rtadvctl/rtadvctl.8 (revision 276258) @@ -1,105 +1,105 @@ .\" Copyright (C) 2011 Hiroki Sato . .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS .\" IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE .\" PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd July 16, 2011 .Dt RTADVCTL 8 .Os .Sh NAME .Nm rtadvctl .Nd control program for .Xr rtadvd 8 daemon .Sh SYNOPSIS .Nm .Op Fl v .Ar subcommand .Op Ar interface ... .Sh DESCRIPTION .Nm is a utility that communicates with .Xr rtadvd 8 daemon and displays information about Router Advertisement messages being sent on each interface. .Pp This utility provides several options and subcommands. The options are as follows: .Bl -tag -width indent .\" .It Fl v Increase verbosity level. When specified once, the .Nm utility shows additional information about prefixes, RDNSS, and DNSSL options. When given twice, it additionally shows information about inactive interfaces and some statistics. .El .Pp The subcommands are as follows: .Bl -tag -width indent .\" .It reload Op interfaces... Specifies to reload the configuration file. If one or more .Ar interface is specified, configuration entries for the interfaces will be reloaded selectively. .It enable interfaces... Specifies to mark the interface as enable and to try to reload the configuration entry. This subcommand is useful for dynamically-added interfaces. .Pp The .Xr rtadvd 8 daemon marks an interface as enable if the interface exists and the configuration file has a valid entry for that when it is invoked. .It disable interfaces... Specifies to mark the interface as disable. .It shutdown Makes the .Xr rtadvd 8 daemon shut down. Note that the .Xr rtadvd 8 daemon will send several RAs with zero lifetime to invalidate the old information on each interface. It will take at most nine seconds. .It show Op interfaces... Displays information on Router Advertisement messages being sent on each interface. .El .Sh SEE ALSO -.Xr rtadvd 8 , -.Xr rtadvd.conf 5 +.Xr rtadvd.conf 5 , +.Xr rtadvd 8 .Sh HISTORY The .Nm command first appeared in .Fx 9.0 . .Sh AUTHORS .Nm was written by .An Hiroki Sato Aq Mt hrs@FreeBSD.org . Index: head/usr.sbin/rtadvd/rtadvd.conf.5 =================================================================== --- head/usr.sbin/rtadvd/rtadvd.conf.5 (revision 276257) +++ head/usr.sbin/rtadvd/rtadvd.conf.5 (revision 276258) @@ -1,530 +1,530 @@ .\" $KAME: rtadvd.conf.5,v 1.50 2005/01/14 05:30:59 jinmei Exp $ .\" .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. Neither the name of the project nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd June 4, 2011 .Dt RTADVD.CONF 5 .Os .Sh NAME .Nm rtadvd.conf .Nd config file for router advertisement daemon .Sh DESCRIPTION This file describes how the router advertisement packets must be constructed for each of the interfaces. .Pp As described in .Xr rtadvd 8 , you do not have to set this configuration file up at all, unless you need some special configurations. You may even omit the file as a whole. In such cases, the .Nm rtadvd daemon will automatically configure itself using default values specified in the specification. .Pp It obeys the famous .Xr termcap 5 file format. Each line in the file describes a network interface. Fields are separated by a colon .Pq Sq \&: , and each field contains one capability description. Lines may be concatenated by the .Sq \e character. The comment marker is the .Sq \&# character. .Sh CAPABILITIES Capabilities describe the value to be filled into ICMPv6 router advertisement messages and to control .Xr rtadvd 8 behavior. Therefore, you are encouraged to read IETF neighbor discovery documents if you would like to modify the sample configuration file. .Pp Note that almost all items have default values. If you omit an item, the default value of the item will be used. .Pp There are two items which control the interval of sending router advertisements. These items can be omitted, then .Nm rtadvd will use the default values. .Bl -tag -width indent .It Cm \&maxinterval (num) The maximum time allowed between sending unsolicited multicast router advertisements .Pq unit: seconds . The default value is 600. Its value must be no less than 4 seconds and no greater than 1800 seconds. .It Cm \&mininterval (num) The minimum time allowed between sending unsolicited multicast router advertisements .Pq unit: seconds . The default value is the one third of value of .Cm maxinterval . Its value must be no less than 3 seconds and no greater than .75 * the value of .Cm maxinterval . .El .Pp The following items are for ICMPv6 router advertisement message header. These items can be omitted, then .Nm rtadvd will use the default values. .Bl -tag -width indent .It Cm \&chlim (num) The value for Cur Hop Limit field. The default value is 64. .It Cm \&raflags (str or num) A 8-bit flags field in router advertisement message header. This field can be specified either as a case-sensitive string or as an integer. A string consists of characters each of which corresponds to a particular flag bit(s). An integer should be the logical OR of all enabled bits. Bit 7 .Po .Li 'm' or 0x80 .Pc means Managed address configuration flag bit, and Bit 6 .Po .Li 'o' or 0x40 .Pc means Other stateful configuration flag bit. Bit 4 .Po .Li 0x10 .Pc and Bit 3 .Po .Li 0x08 .Pc are used to encode router preference. Bits 01 .Po or 'h' .Pc means high, 00 means medium, and 11 .Po or 'l' .Pc means low. Bits 10 is reserved, and must not be specified. There is no character to specify the medium preference explicitly. The default value of the entire flag is 0 .Po or a null string, .Pc which means no additional configuration methods, and the medium router preference. .It Cm \&rltime (num) Router lifetime field .Pq unit: seconds . The value must be either zero or between the value of .Cm maxinterval and 9000. When .Nm rtadvd runs on a host, this value must explicitly set 0 on all the advertising interfaces as described in .Xr rtadvd 8 . The default value is 1800. .It Cm \&rtime (num) Reachable time field .Pq unit: milliseconds . The default value is 0, which means unspecified by this router. .It Cm \&retrans (num) Retrans Timer field .Pq unit: milliseconds . The default value is 0, which means unspecified by this router. .El .Pp The following items are for ICMPv6 prefix information option, which will be attached to router advertisement header. These items can be omitted, then .Nm rtadvd will automatically get appropriate prefixes from the kernel's routing table, and advertise the prefixes with the default parameters. Keywords other than .Cm clockskew and .Cm noifprefix can be augmented with a number, like .Dq Li prefix2 , to specify multiple prefixes. .Bl -tag -width indent .It Cm \&noifprefix (bool) Specifies no prefix on the network interfaces will be advertised. By default .Nm rtadvd automatically gathers on-link prefixes from all of the network interfaces and advertise them. The .Cm noifprefix disables that behavior. If this is specified and no .Cm addr keyword is specified, no prefix information option will be included in the message. .It Cm \&clockskew (num) Time skew to adjust link propagation delays and clock skews between routers on the link .Pq unit: seconds . This value is used in consistency check for locally-configured and advertised prefix lifetimes, and has its meaning when the local router configures a prefix on the link with a lifetime that decrements in real time. If the value is 0, it means the consistency check will be skipped for such prefixes. The default value is 0. .It Cm \&prefixlen (num) Prefix length field. The default value is 64. .It Cm \&pinfoflags (str or num) A 8-bit flags field in prefix information option. This field can be specified either as a case-sensitive string or as an integer. A string consists of characters each of which corresponds to a particular flag bit(s). An integer should be the logical OR of all enabled bits. Bit 7 .Po .Li 'l' or 0x80 .Pc means On-link flag bit, and Bit 6 .Po .Li 'a' or 0x40 .Pc means Autonomous address-configuration flag bit. The default value is "la" or 0xc0, i.e., both bits are set. .It Cm \&addr (str) The address filled into Prefix field. Since .Dq \&: is used for .Xr termcap 5 file format as well as IPv6 numeric address, the field MUST be quoted by doublequote character. .It Cm \&vltime (num) Valid lifetime field .Pq unit: seconds . The default value is 2592000 (30 days). .It Cm \&vltimedecr (bool) This item means the advertised valid lifetime will decrement in real time, which is disabled by default. .It Cm \&pltime (num) Preferred lifetime field .Pq unit: seconds . The default value is 604800 (7 days). .It Cm \&pltimedecr (bool) This item means the advertised preferred lifetime will decrement in real time, which is disabled by default. .El .Pp The following item is for ICMPv6 MTU option, which will be attached to router advertisement header. This item can be omitted, then .Nm rtadvd will use the default value. .Bl -tag -width indent .It Cm \&mtu (num or str) MTU (maximum transmission unit) field. If 0 is specified, it means that the option will not be included. The default value is 0. If the special string .Dq auto is specified for this item, MTU option will be included and its value will be set to the interface MTU automatically. .El .Pp The following item controls ICMPv6 source link-layer address option, which will be attached to router advertisement header. As noted above, you can just omit the item, then .Nm rtadvd will use the default value. .Bl -tag -width indent .It Cm \&nolladdr (bool) By default .Po if .Cm \&nolladdr is not specified .Pc , .Xr rtadvd 8 will try to get link-layer address for the interface from the kernel, and attach that in source link-layer address option. If this capability exists, .Xr rtadvd 8 will not attach source link-layer address option to router advertisement packets. .El .Pp The following item controls ICMPv6 home agent information option, which was defined with mobile IPv6 support. It will be attached to router advertisement header just like other options do. .Bl -tag -width indent .It Cm \&hapref (num) Specifies home agent preference. If set to non-zero, .Cm \&hatime must be present as well. .It Cm \&hatime (num) Specifies home agent lifetime. .El .Pp When mobile IPv6 support is turned on for .Xr rtadvd 8 , advertisement interval option will be attached to router advertisement packet, by configuring .Cm \&maxinterval explicitly. .Pp The following items are for ICMPv6 route information option, which will be attached to router advertisement header. These items are optional. Each items can be augmented with number, like .Dq Li rtplen2 , to specify multiple routes. .Bl -tag -width indent .It Cm \&rtprefix (str) The prefix filled into the Prefix field of route information option. Since .Dq \&: is used for .Xr termcap 5 file format as well as IPv6 numeric address, the field MUST be quoted by doublequote character. .It Cm \&rtplen (num) Prefix length field in route information option. The default value is 64. .It Cm \&rtflags (str or num) A 8-bit flags field in route information option. Currently only the preference values are defined. The notation is same as that of the raflags field. Bit 4 .Po .Li 0x10 .Pc and Bit 3 .Po .Li 0x08 .Pc are used to encode the route preference for the route. The default value is 0x00, i.e., medium preference. .It Cm \&rtltime (num) route lifetime field in route information option. .Pq unit: seconds . Since the specification does not define the default value of this item, the value for this item should be specified by hand. However, .Nm rtadvd allows this item to be unspecified, and uses the router lifetime as the default value in such a case, just for compatibility with an old version of the program. .El .Pp In the above list, each keyword beginning with .Dq Li rt could be replaced with the one beginning with .Dq Li rtr for backward compatibility reason. For example, .Cm rtrplen is accepted instead of .Cm rtplen . However, keywords that start with .Dq Li rtr have basically been obsoleted, and should not be used any more. .Pp The following items are for ICMPv6 Recursive DNS Server Option and DNS Search List Option .Pq RFC 6106 , which will be attached to router advertisement header. These items are optional. .Bl -tag -width indent .It Cm \&rdnss (str) The IPv6 address of one or more recursive DNS servers. The argument must be inside double quotes. Multiple DNS servers can be specified in a comma-separated string. If different lifetimes are needed for different servers, separate entries can be given by using .Cm rdnss , .Cm rdnss0 , .Cm rdnss1 , .Cm rdnss2 ... options with corresponding .Cm rdnssltime , .Cm rdnssltime0 , .Cm rdnssltime1 , .Cm rdnssltime2 ... entries. Note that the maximum number of servers depends on the receiver side. See also .Xr resolver 5 manual page for resolver implementation in .Fx . .It Cm \&rdnssltime The lifetime of the .Cm rdnss DNS server entries. The default value is 3/2 of the interval time. .It Cm \&dnssl (str) One or more domain names in a comma-separated string. These domain names will be used when making DNS queries on a non-fully-qualified domain name. If different lifetimes are needed for different domains, separate entries can be given by using .Cm dnssl , .Cm dnssl0 , .Cm dnssl1 , .Cm dnssl2 ... options with corresponding .Cm dnsslltime , .Cm dnsslltime0 , .Cm dnsslltime1 , .Cm dnsslltime2 ... entries. Note that the maximum number of names depends on the receiver side. See also .Xr resolver 5 manual page for resolver implementation in .Fx . .It Cm \&dnsslltime The lifetime of the .Cm dnssl DNS search list entries. The default value is 3/2 of the interval time. .El .Pp You can also refer one line from another by using .Cm tc capability. See .Xr termcap 5 for details on the capability. .Sh EXAMPLES As presented above, all of the advertised parameters have default values defined in specifications, and hence you usually do not have to set them by hand, unless you need special non-default values. It can cause interoperability problem if you use an ill-configured parameter. .Pp To override a configuration parameter, you can specify the parameter alone. With the following configuration, .Xr rtadvd 8 overrides the router lifetime parameter for the .Li ne0 interface. .Bd -literal -offset indent ne0:\\ :rltime#0: .Ed .Pp The following example manually configures prefixes advertised from the .Li ef0 interface. The configuration must be used with the .Fl s option to .Xr rtadvd 8 . .Bd -literal -offset indent ef0:\\ :addr="2001:db8:ffff:1000::":prefixlen#64: .Ed .Pp The following example configures the .Li wlan0 interface and adds two DNS servers and a DNS domain search options using the default option lifetime values. .Bd -literal -offset indent wlan0:\\ :addr="2001:db8:ffff:1000::":prefixlen#64:\\ :rdnss="2001:db8:ffff::10,2001:db8:ffff::2:43":\\ :dnssl="example.com": .Ed .Pp The following example presents the default values in an explicit manner. The configuration is provided just for reference purposes; YOU DO NOT NEED TO HAVE IT AT ALL. .Bd -literal -offset indent default:\\ :chlim#64:raflags#0:rltime#1800:rtime#0:retrans#0:\\ :pinfoflags="la":vltime#2592000:pltime#604800:mtu#0: ef0:\\ :addr="2001:db8:ffff:1000::":prefixlen#64:tc=default: .Ed .Sh SEE ALSO -.Xr termcap 5 , .Xr resolver 5 , +.Xr termcap 5 , .Xr rtadvd 8 , .Xr rtsol 8 .Rs .%A Thomas Narten .%A Erik Nordmark .%A W. A. Simpson .%A Hesham Soliman .%T Neighbor Discovery for IP version 6 (IPv6) .%R RFC 4861 .Re .Rs .%A Thomas Narten .%A Erik Nordmark .%A W. A. Simpson .%T Neighbor Discovery for IP version 6 (IPv6) .%R RFC 2461 (obsoleted by RFC 4861) .Re .Rs .%A Richard Draves .%T Default Router Preferences and More-Specific Routes .%R draft-ietf-ipngwg-router-selection-xx.txt .Re .Rs .%A J. Jeong .%A S. Park .%A L. Beloeil .%A S. Madanapalli .%T IPv6 Router Advertisement Options for DNS Configuration .%R RFC 6106 .Re .Sh HISTORY The .Xr rtadvd 8 and the configuration file .Nm first appeared in WIDE Hydrangea IPv6 protocol stack kit. .\" .Sh BUGS .\" (to be written)