Fix a few mandoc issues

- no blank before trailing delimiter
- whitespace at end of input line
- sections out of conventional order
- normalizing date format
- AUTHORS section without An macro
This commit is contained in:
Gordon Bergling 2020-10-09 14:03:45 +00:00
parent 72479f6bf9
commit 6d6d6c3603
15 changed files with 172 additions and 140 deletions

View File

@ -69,6 +69,8 @@ Produce more verbose output.
.Sh SEE ALSO .Sh SEE ALSO
.Xr devinfo 8 , .Xr devinfo 8 ,
.Xr MODULE_PNP_INFO 9 .Xr MODULE_PNP_INFO 9
.Sh AUTHORS
.An Warner Losh Aq Mt imp@FreeBSD.org
.Sh BUGS .Sh BUGS
The kernel has hints in it, but we exclude it from the list of modules The kernel has hints in it, but we exclude it from the list of modules
to suggest for unmatched devices. to suggest for unmatched devices.
@ -92,5 +94,3 @@ logical equivalent in USB, PCI, and others.
.Pp .Pp
Many drivers currently lack proper PNP table decorations and need to Many drivers currently lack proper PNP table decorations and need to
be updated. be updated.
.Sh AUTHORS
.An Warner Losh Aq Mt imp@FreeBSD.org

View File

@ -592,7 +592,7 @@ Note that this must be configured on a physical interface associated with
not on a not on a
.Xr vlan 4 .Xr vlan 4
interface itself. interface itself.
.It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso .It Fl vlanmtu , vlanhwtag , vlanhwfilter , vlanhwtso
If the driver offers user-configurable VLAN support, disable If the driver offers user-configurable VLAN support, disable
reception of extended frames, tag processing in hardware, reception of extended frames, tag processing in hardware,
frame filtering in hardware, or TSO on VLAN, frame filtering in hardware, or TSO on VLAN,

View File

@ -202,7 +202,7 @@ and first appeared in
was renamed to the more aptly-named was renamed to the more aptly-named
.Nm .Nm
in in
.Fx 5.0. .Fx 5.0 .
The character code conversion routine was added in 2003. The character code conversion routine was added in 2003.
.Sh AUTHORS .Sh AUTHORS
Initial implementation as Initial implementation as

View File

@ -291,7 +291,8 @@ The
.Dv SAY .Dv SAY
strings could be used to give progress messages in sections of strings could be used to give progress messages in sections of
the script where you want to have 'ECHO OFF' but still let the user the script where you want to have 'ECHO OFF' but still let the user
know what is happening. An example is: know what is happening.
An example is:
.Bd -literal -offset indent .Bd -literal -offset indent
ABORT BUSY ABORT BUSY
ECHO OFF ECHO OFF

View File

@ -63,7 +63,7 @@ Calculate block counts in
.Ar blocksize .Ar blocksize
byte blocks. byte blocks.
This is different from the This is different from the
.Fl h, k, m, .Fl h , k , m ,
.Fl Fl si .Fl Fl si
and and
.Fl g .Fl g
@ -172,7 +172,7 @@ options override each other and the command's actions are determined
by the last one specified. by the last one specified.
.Pp .Pp
The The
.Fl h, k, m .Fl h , k , m
and and
.Fl Fl si .Fl Fl si
options all override each other; the last one specified determines options all override each other; the last one specified determines
@ -183,7 +183,7 @@ the block counts used.
If the environment variable If the environment variable
.Ev BLOCKSIZE .Ev BLOCKSIZE
is set, and the is set, and the
.Fl h, k, m .Fl h , k , m
or or
.Fl Fl si .Fl Fl si
options are not specified, the block counts will be displayed in units of options are not specified, the block counts will be displayed in units of
@ -191,7 +191,7 @@ that block size.
If If
.Ev BLOCKSIZE .Ev BLOCKSIZE
is not set, and the is not set, and the
.Fl h, k, m .Fl h , k , m
or or
.Fl Fl si .Fl Fl si
options are not specified, the block counts will be displayed in 512-byte options are not specified, the block counts will be displayed in 512-byte

View File

@ -61,8 +61,8 @@ Select svideo input.
.It Fl t .It Fl t
Select tuner. Select tuner.
.It Fl g Cm geom .It Fl g Cm geom
Select geometry. The first resolution is for NTSC, the second for Select geometry.
PAL. The first resolution is for NTSC, the second for PAL.
.Pp .Pp
VCD: 352x240 or 352x288 VCD: 352x240 or 352x288
SVCD: 480x480 or 480x576 SVCD: 480x480 or 480x576
@ -91,7 +91,8 @@ Frequency in MHz (must include decimal point).
.Sh HISTORY .Sh HISTORY
The The
.Nm .Nm
program first appeared in the -multimedia mailing-list in January 2004. The program first appeared in the -multimedia mailing-list in January 2004.
The
.Nm .Nm
program first appeared in the FreeBSD Ports collection in October 2004. program first appeared in the FreeBSD Ports collection in October 2004.
.Sh AUTHORS .Sh AUTHORS

View File

@ -74,7 +74,8 @@ Shorthand for "mode binary"
Sets the TFTP blksize option in TFTP Read Request or Write Request packets Sets the TFTP blksize option in TFTP Read Request or Write Request packets
to to
.Ar [size] .Ar [size]
as specified in RFC 2348. Valid values are between 8 and 65464. as specified in RFC 2348.
Valid values are between 8 and 65464.
If no blocksize is specified, then by default a blocksize of 512 bytes If no blocksize is specified, then by default a blocksize of 512 bytes
will be used. will be used.
.Pp .Pp
@ -82,8 +83,8 @@ will be used.
Sets the TFTP blksize2 option in TFTP Read Request or Write Request packets Sets the TFTP blksize2 option in TFTP Read Request or Write Request packets
to to
.Ar [size] . .Ar [size] .
Values are restricted to powers of 2 between 8 and 32768. This is a Values are restricted to powers of 2 between 8 and 32768.
non-standard TFTP option. This is a non-standard TFTP option.
.Pp .Pp
.It Cm connect Ar host Op Ar port .It Cm connect Ar host Op Ar port
Set the Set the
@ -109,7 +110,8 @@ or
commands. commands.
.Pp .Pp
.It Cm debug Ar level .It Cm debug Ar level
Enable or disable debugging levels during verbose output. The value of Enable or disable debugging levels during verbose output.
The value of
.Ar level .Ar level
can be one of can be one of
.Cm packet , simple , options , .Cm packet , simple , options ,
@ -156,7 +158,8 @@ The default is
.It Cm packetdrop [arg] .It Cm packetdrop [arg]
Randomly drop Randomly drop
.Ar arg .Ar arg
out of 100 packets during a transfer. This is a debugging feature. out of 100 packets during a transfer.
This is a debugging feature.
.Pp .Pp
.It Cm put Ar file Op Oo Ar host : Oc Ns Ar remotename .It Cm put Ar file Op Oo Ar host : Oc Ns Ar remotename
.It Cm put Ar file1 file2 ... fileN Op Oo Ar host : Oc Ns Ar remote-directory .It Cm put Ar file1 file2 ... fileN Op Oo Ar host : Oc Ns Ar remote-directory
@ -178,7 +181,8 @@ see the example under the
command. command.
.Pp .Pp
.It Cm options Ar [arg] .It Cm options Ar [arg]
Enable or disable support for TFTP options. The valid values of Enable or disable support for TFTP options.
The valid values of
.Ar arg .Ar arg
are are
.Cm on .Cm on
@ -198,8 +202,8 @@ Set the per-packet retransmission timeout, in seconds.
.Pp .Pp
.It Cm rollover [arg] .It Cm rollover [arg]
Specify the rollover option in TFTP Read Request or Write Specify the rollover option in TFTP Read Request or Write
Request packets. After 65535 packets have been transmitted, set the block Request packets.
counter to After 65535 packets have been transmitted, set the block counter to
.Ar arg . .Ar arg .
Valid values of Valid values of
.Ar arg .Ar arg

View File

@ -233,8 +233,8 @@ utility take the following optional arguments:
.It Fl C Ar retries .It Fl C Ar retries
Specify the number of times to retry a command in the event of failure. Specify the number of times to retry a command in the event of failure.
.It Fl D Ar device .It Fl D Ar device
Specify the device to open. This allows opening a device other than the Specify the device to open.
default device, This allows opening a device other than the default device,
.Pa /dev/cam/ctl , .Pa /dev/cam/ctl ,
to be opened for sending commands. to be opened for sending commands.
.It Fl I Ar id .It Fl I Ar id
@ -272,29 +272,31 @@ READ command to the device, and write the requested data to a file or
stdout. stdout.
.Bl -tag -width 12n .Bl -tag -width 12n
.It Fl l Ar lba .It Fl l Ar lba
Specify the starting Logical Block Address for the READ. This can be Specify the starting Logical Block Address for the READ.
specified in decimal, octal (starting with 0), hexadecimal (starting with This can be specified in decimal, octal (starting with 0),
0x) or any other base supported by hexadecimal (starting with 0x) or any other base supported by
.Xr strtoull 3 . .Xr strtoull 3 .
.It Fl d Ar datalen .It Fl d Ar datalen
Specify the length, in 512 byte blocks, of the READ request. Specify the length, in 512 byte blocks, of the READ request.
.It Fl f Ar file .It Fl f Ar file
Specify the destination for the data read by the READ command. Either a Specify the destination for the data read by the READ command.
filename or Either a filename or
.Sq - .Sq -
for stdout may be specified. for stdout may be specified.
.It Fl c Ar cdbsize .It Fl c Ar cdbsize
Specify the minimum Specify the minimum
.Tn SCSI .Tn SCSI
CDB (Command Data Block) size to be used for the READ request. Allowable CDB (Command Data Block) size to be used for the READ request.
values are 6, 10, 12 and 16. Depending upon the LBA and amount of data Allowable values are 6, 10, 12 and 16.
requested, a larger CDB size may be used to satisfy the request. (e.g., Depending upon the LBA and amount of data requested, a larger CDB
for LBAs above 0xffffffff, READ(16) must be used to satisfy the request.) size may be used to satisfy the request. (e.g., for LBAs above 0xffffffff,
READ(16) must be used to satisfy the request.)
.It Fl b Ar blocksize .It Fl b Ar blocksize
Specify the blocksize of the underlying Specify the blocksize of the underlying
.Tn SCSI .Tn SCSI
device, so the transfer length device, so the transfer length
can be calculated accurately. The blocksize can be obtained via the can be calculated accurately.
The blocksize can be obtained via the
.Tn SCSI .Tn SCSI
READ CAPACITY command. READ CAPACITY command.
.It Fl N .It Fl N
@ -310,29 +312,31 @@ Read data from a file or stdin, and write the data to the device using the
WRITE command. WRITE command.
.Bl -tag -width 12n .Bl -tag -width 12n
.It Fl l Ar lba .It Fl l Ar lba
Specify the starting Logical Block Address for the WRITE. This can be Specify the starting Logical Block Address for the WRITE.
specified in decimal, octal (starting with 0), hexadecimal (starting with This can be specified in decimal, octal (starting with 0), hexadecimal
0x) or any other base supported by (starting with 0x) or any other base supported by
.Xr strtoull 3 . .Xr strtoull 3 .
.It Fl d Ar atalen .It Fl d Ar atalen
Specify the length, in 512 byte blocks, of the WRITE request. Specify the length, in 512 byte blocks, of the WRITE request.
.It Fl f Ar file .It Fl f Ar file
Specify the source for the data to be written by the WRITE command. Either a Specify the source for the data to be written by the WRITE command.
filename or Either a filename or
.Sq - .Sq -
for stdin may be specified. for stdin may be specified.
.It Fl c Ar cdbsize .It Fl c Ar cdbsize
Specify the minimum Specify the minimum
.Tn SCSI .Tn SCSI
CDB (Command Data Block) size to be used for the READ request. Allowable CDB (Command Data Block) size to be used for the READ request.
values are 6, 10, 12 and 16. Depending upon the LBA and amount of data Allowable values are 6, 10, 12 and 16.
requested, a larger CDB size may be used to satisfy the request. (e.g., Depending upon the LBA and amount of data requested, a larger CDB size
for LBAs above 0xffffffff, READ(16) must be used to satisfy the request.) may be used to satisfy the request. (e.g., for LBAs above 0xffffffff, READ(16)
must be used to satisfy the request.)
.It Fl b Ar blocksize .It Fl b Ar blocksize
Specify the blocksize of the underlying Specify the blocksize of the underlying
.Tn SCSI .Tn SCSI
device, so the transfer length device, so the transfer length
can be calculated accurately. The blocksize can be obtained via the can be calculated accurately.
The blocksize can be obtained via the
.Tn SCSI .Tn SCSI
READ CAPACITY command. READ CAPACITY command.
.It Fl N .It Fl N
@ -346,18 +350,20 @@ This is to be used for performance testing.
Send the Send the
.Tn SCSI .Tn SCSI
READ CAPACITY command to the device and display the device size and device READ CAPACITY command to the device and display the device size and device
block size. By default, READ CAPACITY(10) is block size.
used. If the device returns a maximum LBA of 0xffffffff, however, By default, READ CAPACITY(10) is used.
If the device returns a maximum LBA of 0xffffffff, however,
.Nm .Nm
will automatically issue a READ CAPACITY(16), which is implemented as a will automatically issue a READ CAPACITY(16), which is implemented as a
service action of the SERVICE ACTION IN(16) opcode. The user can specify service action of the SERVICE ACTION IN(16) opcode.
the minimum CDB size with the The user can specify the minimum CDB size with the
.Fl c .Fl c
argument. Valid values for the argument.
Valid values for the
.Fl c .Fl c
option are 10 and 16. If a 10 byte CDB is specified, the request will be option are 10 and 16.
automatically reissued with a 16 byte CDB if the maximum LBA returned is If a 10 byte CDB is specified, the request will be automatically reissued
0xffffffff. with a 16 byte CDB if the maximum LBA returned is 0xffffffff.
.It Ic modesense .It Ic modesense
Send a Send a
.Tn SCSI .Tn SCSI
@ -365,17 +371,21 @@ MODE SENSE command to the device, and display the requested mode page(s) or
page list. page list.
.Bl -tag -width 10n .Bl -tag -width 10n
.It Fl m Ar page .It Fl m Ar page
Specify the mode page to display. This option and the Specify the mode page to display.
This option and the
.Fl l .Fl l
option are mutually exclusive. One of the two must be specified, though. option are mutually exclusive.
One of the two must be specified, though.
Mode page numbers may be specified in decimal or hexadecimal. Mode page numbers may be specified in decimal or hexadecimal.
.It Fl l .It Fl l
Request that the list of mode pages supported by the device be returned. Request that the list of mode pages supported by the device be returned.
This option and the This option and the
.Fl m .Fl m
option are mutually exclusive. One of the two must be specified, though. option are mutually exclusive.
One of the two must be specified, though.
.It Fl P Ar pc .It Fl P Ar pc
Specify the mode page control value. Possible values are: Specify the mode page control value.
Possible values are:
.Bl -tag -width 2n -compact .Bl -tag -width 2n -compact
.It 0 .It 0
Current values. Current values.
@ -391,8 +401,8 @@ Disable block descriptors when sending the mode sense request.
.It Fl S Ar subpage .It Fl S Ar subpage
Specify the subpage used with the mode sense request. Specify the subpage used with the mode sense request.
.It Fl c Ar cdbsize .It Fl c Ar cdbsize
Specify the CDB size used for the mode sense request. Supported values are Specify the CDB size used for the mode sense request.
6 and 10. Supported values are 6 and 10.
.El .El
.It Ic start .It Ic start
Send the Send the
@ -401,54 +411,56 @@ START STOP UNIT command to the specified LUN with the start
bit set. bit set.
.Bl -tag -width 4n .Bl -tag -width 4n
.It Fl i .It Fl i
Set the immediate bit in the CDB. Note that CTL does not support the Set the immediate bit in the CDB.
immediate bit, so this is primarily useful for making sure that CTL returns Note that CTL does not support the immediate bit, so this is primarily
the proper error. useful for making sure that CTL returns the proper error.
.El .El
.It Ic stop .It Ic stop
Send the Send the
.Tn SCSI .Tn SCSI
START STOP UNIT command to the specified LUN with the start START STOP UNIT command to the specified LUN with the start
bit cleared. We use an ordered tag to stop the LUN, so we can guarantee bit cleared.
that all pending I/O executes before it is stopped. (CTL guarantees this We use an ordered tag to stop the LUN, so we can guarantee that all pending
anyway, but I/O executes before it is stopped.
(CTL guarantees this anyway, but
.Nm .Nm
sends an ordered tag for completeness.) sends an ordered tag for completeness.)
.Bl -tag -width 4n .Bl -tag -width 4n
.It Fl i .It Fl i
Set the immediate bit in the CDB. Note that CTL does not support the Set the immediate bit in the CDB.
immediate bit, so this is primarily useful for making sure that CTL returns Note that CTL does not support the immediate bit, so this is primarily
the proper error. useful for making sure that CTL returns the proper error.
.El .El
.It Ic synccache .It Ic synccache
Send the Send the
.Tn SCSI .Tn SCSI
SYNCHRONIZE CACHE command to the device. By default, SYNCHRONIZE SYNCHRONIZE CACHE command to the device.
CACHE(10) is used. If the specified starting LBA is greater than By default, SYNCHRONIZE CACHE(10) is used.
0xffffffff or the length is greater than 0xffff, though, If the specified starting LBA is greater than 0xffffffff or the length is
SYNCHRONIZE CACHE(16) will be used. The 16 byte command will also be used greater than 0xffff, though, SYNCHRONIZE CACHE(16) will be used.
if the user specifies a 16 byte CDB with the The 16 byte command will also be used if the user specifies a 16 byte CDB with the
.Fl c .Fl c
argument. argument.
.Bl -tag -width 14n .Bl -tag -width 14n
.It Fl l Ar lba .It Fl l Ar lba
Specify the starting LBA of the cache region to synchronize. This option is a Specify the starting LBA of the cache region to synchronize.
no-op for CTL. If you send a SYNCHRONIZE CACHE command, it will sync the This option is a no-op for CTL.
cache for the entire LUN. If you send a SYNCHRONIZE CACHE command, it will sync the cache for the entire LUN.
.It Fl b Ar blockcount .It Fl b Ar blockcount
Specify the length of the cache region to synchronize. This option is a Specify the length of the cache region to synchronize.
no-op for CTL. If you send a SYNCHRONIZE CACHE command, it will sync the This option is a no-op for CTL.
cache for the entire LUN. If you send a SYNCHRONIZE CACHE command, it will sync the cache for the entire LUN.
.It Fl r .It Fl r
Specify relative addressing for the starting LBA. CTL does not support Specify relative addressing for the starting LBA.
relative addressing, since it only works for linked commands, and CTL CTL does not support relative addressing, since it only works for linked commands,
does not support linked commands. and CTL does not support linked commands.
.It Fl i .It Fl i
Tell the target to return status immediately after issuing the SYNCHRONIZE CACHE Tell the target to return status immediately after issuing the SYNCHRONIZE CACHE
command rather than waiting for the cache to finish syncing. CTL does not command rather than waiting for the cache to finish syncing.
support this bit. CTL does not support this bit.
.It Fl c Ar cdbsize .It Fl c Ar cdbsize
Specify the minimum CDB size. Valid values are 10 and 16 bytes. Specify the minimum CDB size.
Valid values are 10 and 16 bytes.
.El .El
.It Ic lunlist .It Ic lunlist
List all LUNs registered with CTL. List all LUNs registered with CTL.
@ -457,14 +469,15 @@ Because this command uses the ioctl port, it will only work when the FETDs
This command is the equivalent of doing a REPORT LUNS on one LUN and then This command is the equivalent of doing a REPORT LUNS on one LUN and then
an INQUIRY on each LUN in the system. an INQUIRY on each LUN in the system.
.It Ic delay .It Ic delay
Delay commands at the given location. There are two places where commands Delay commands at the given location.
may be delayed currently: before data is transferred There are two places where commands may be delayed currently: before data is transferred
.Pq Dq datamove .Pq Dq datamove
and just prior to sending status to the host and just prior to sending status to the host
.Pq Dq done . .Pq Dq done .
One of the two must be supplied as an argument to the One of the two must be supplied as an argument to the
.Fl l .Fl l
option. The option.
The
.Fl t .Fl t
option must also be specified. option must also be specified.
.Bl -tag -width 12n .Bl -tag -width 12n
@ -473,9 +486,10 @@ Delay command(s) at the specified location.
This can either be at the data movement stage (datamove) or prior to This can either be at the data movement stage (datamove) or prior to
command completion (done). command completion (done).
.It Fl t Ar delaytime .It Fl t Ar delaytime
Delay command(s) for the specified number of seconds. This must be Delay command(s) for the specified number of seconds.
specified. If set to 0, it will clear out any previously set delay for This must be specified.
this particular location (datamove or done). If set to 0, it will clear out any previously set delay for this particular
location (datamove or done).
.It Fl T Ar delaytype .It Fl T Ar delaytype
Specify the delay type. Specify the delay type.
By default, the By default, the
@ -898,11 +912,12 @@ as write protected.
Set to "on", makes LUN removable. Set to "on", makes LUN removable.
.It Va reordering .It Va reordering
Set to "unrestricted", allows target to process commands with SIMPLE task Set to "unrestricted", allows target to process commands with SIMPLE task
attribute in arbitrary order. Any data integrity exposures related to attribute in arbitrary order.
command sequence order shall be explicitly handled by the application Any data integrity exposures related to command sequence order shall be
client through the selection of appropriate commands and task attributes. explicitly handled by the application client through the selection of
The default value is "restricted". It improves data integrity, but may appropriate commands and task attributes.
introduce some additional delays. The default value is "restricted".
It improves data integrity, but may introduce some additional delays.
.It Va serseq .It Va serseq
Set to "on" to serialize consecutive reads/writes. Set to "on" to serialize consecutive reads/writes.
Set to "read" to serialize consecutive reads. Set to "read" to serialize consecutive reads.

View File

@ -178,4 +178,4 @@ and introduced in
It was developed to support security extensions requiring additional labels It was developed to support security extensions requiring additional labels
to be associated with each file or directory. to be associated with each file or directory.
.Sh AUTHORS .Sh AUTHORS
Robert N M Watson .An Robert N M Watson

View File

@ -55,8 +55,8 @@
The The
.Nm .Nm
utility can be used to perform raw data transfers (read or write) with devices utility can be used to perform raw data transfers (read or write) with devices
on the I2C bus. It can also scan the bus for available devices and reset the on the I2C bus.
I2C controller. It can also scan the bus for available devices and reset the I2C controller.
.Pp .Pp
The options are as follows: The options are as follows:
.Bl -tag -width ".Fl d Ar direction" .Bl -tag -width ".Fl d Ar direction"
@ -124,10 +124,10 @@ Zero means that the offset is ignored and not passed to the slave at all.
.Sh WARNINGS .Sh WARNINGS
Great care must be taken when manipulating slave I2C devices with the Great care must be taken when manipulating slave I2C devices with the
.Nm .Nm
utility. Often times important configuration data for the system is kept in utility.
non-volatile but write enabled memories located on the I2C bus, for example Often times important configuration data for the system is kept in non-volatile
Ethernet hardware addresses, RAM module parameters (SPD), processor reset but write enabled memories located on the I2C bus, for example Ethernet hardware
configuration word etc. addresses, RAM module parameters (SPD), processor reset configuration word etc.
.Pp .Pp
It is very easy to render the whole system unusable when such configuration It is very easy to render the whole system unusable when such configuration
data is deleted or altered, so use the data is deleted or altered, so use the
@ -135,13 +135,14 @@ data is deleted or altered, so use the
(write) command only if you know exactly what you are doing. (write) command only if you know exactly what you are doing.
.Pp .Pp
Also avoid ungraceful interrupting of an ongoing transaction on the I2C bus, Also avoid ungraceful interrupting of an ongoing transaction on the I2C bus,
as it can lead to potentially dangerous effects. Consider the following as it can lead to potentially dangerous effects.
scenario: when the host CPU is reset (for whatever reason) in the middle of a Consider the following scenario: when the host CPU is reset (for whatever reason)
started I2C transaction, the I2C slave device could be left in write mode in the middle of a started I2C transaction, the I2C slave device could be left
waiting for data or offset to arrive. When the CPU reinitializes itself and in write mode waiting for data or offset to arrive.
talks to this I2C slave device again, the commands and other control info it When the CPU reinitializes itself and talks to this I2C slave device again,
sends are treated by the slave device as data or offset it was waiting for, the commands and other control info it sends are treated by the slave device
and there's great potential for corruption if such a write is performed. as data or offset it was waiting for, and there's great potential for
corruption if such a write is performed.
.Sh EXAMPLES .Sh EXAMPLES
.Bl -bullet .Bl -bullet
.It .It

View File

@ -28,7 +28,7 @@
.\" @(#)exports.5 8.3 (Berkeley) 3/29/95 .\" @(#)exports.5 8.3 (Berkeley) 3/29/95
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd Feb 11, 2019 .Dd February 11, 2019
.Dt EXPORTS 5 .Dt EXPORTS 5
.Os .Os
.Sh NAME .Sh NAME
@ -316,9 +316,10 @@ There can only be one NFSv4 root directory per server.
As such, all entries of this form must specify the same directory path. As such, all entries of this form must specify the same directory path.
For file systems other than ZFS, For file systems other than ZFS,
this location can be any directory and does not this location can be any directory and does not
need to be within an exported file system. If it is not in an exported need to be within an exported file system.
file system, a very limited set of operations are permitted, so that an If it is not in an exported file system, a very limited set of operations
NFSv4 client can traverse the tree to an exported file system. are permitted, so that an NFSv4 client can traverse the tree to an
exported file system.
Although parts of the NFSv4 tree can be non-exported, the entire NFSv4 tree Although parts of the NFSv4 tree can be non-exported, the entire NFSv4 tree
must consist of local file systems capable of being exported via NFS. must consist of local file systems capable of being exported via NFS.
All ZFS file systems in the subtree below the NFSv4 tree root must be All ZFS file systems in the subtree below the NFSv4 tree root must be
@ -330,10 +331,11 @@ mount points.
The The
.Fl sec .Fl sec
option on these line(s) specifies what security flavors may be used for option on these line(s) specifies what security flavors may be used for
NFSv4 operations that do not use file handles. Since these operations NFSv4 operations that do not use file handles.
(SetClientID, SetClientIDConfirm, Renew, DelegPurge and ReleaseLockOnwer) Since these operations (SetClientID, SetClientIDConfirm, Renew, DelegPurge
allocate/modify state in the server, it is possible to restrict some clients to and ReleaseLockOnwer) allocate/modify state in the server, it is possible
the use of the krb5[ip] security flavors, via this option. to restrict some clients to the use of the krb5[ip] security flavors,
via this option.
See the See the
.Sx EXAMPLES .Sx EXAMPLES
section below. section below.
@ -507,12 +509,13 @@ V4: /wingsdl/nfsv4
.Ed .Ed
.Pp .Pp
Only one V4: line is needed or allowed to declare where NFSv4 is Only one V4: line is needed or allowed to declare where NFSv4 is
rooted. The other lines declare specific exported directories with rooted.
The other lines declare specific exported directories with
their absolute paths given in /etc/exports. their absolute paths given in /etc/exports.
.Pp .Pp
The exported directories' paths are used for both v3 and v4. The exported directories' paths are used for both v3 and v4.
However, they are interpreted differently for v3 and v4. A client However, they are interpreted differently for v3 and v4.
mount command for usr-ports would use the server-absolute name when A client mount command for usr-ports would use the server-absolute name when
using nfsv3: using nfsv3:
.Bd -literal -offset indent .Bd -literal -offset indent
mount server:/wingsdl/nfsv4/usr-ports /mnt/tmp mount server:/wingsdl/nfsv4/usr-ports /mnt/tmp
@ -525,8 +528,9 @@ mount server:/usr-ports /mnt/tmp
.Ed .Ed
.Pp .Pp
This also differentiates which version you want if the client can do This also differentiates which version you want if the client can do
both v3 and v4. The former will only ever do a v3 mount and the both v3 and v4.
latter will only ever do a v4 mount. The former will only ever do a v3 mount and the latter will only ever
do a v4 mount.
.Pp .Pp
Note that due to different mount behavior between NFSv3 and NFSv4 a Note that due to different mount behavior between NFSv3 and NFSv4 a
NFSv4 mount request for a directory that the client does not have NFSv4 mount request for a directory that the client does not have

View File

@ -53,11 +53,12 @@ owner and owner_group strings.
It also provides support for manage-gids and must be running on the server if It also provides support for manage-gids and must be running on the server if
this is being used for any version of NFS. this is being used for any version of NFS.
.Pp .Pp
Upon startup, it loads the machines DNS domain name, plus timeout and Upon startup, it loads the machines DNS domain name, plus timeout and cache size
cache size limit into the kernel. It then preloads the cache with group limit into the kernel.
and user information, up to the cache size limit and forks off N children It then preloads the cache with group and user information, up to the cache size
(default 4), that service requests from the kernel for cache misses. The limit and forks off N children (default 4), that service requests from the kernel
master server is there for the sole purpose of killing off the slaves. 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. To stop the nfsuserd, send a SIGUSR1 to the master server.
.Pp .Pp
The following options are available: The following options are available:
@ -72,13 +73,14 @@ reported by
Overrides the default timeout for cache entries, in minutes. Overrides the default timeout for cache entries, in minutes.
The longer the The longer the
time out, the better the performance, but the longer it takes for replaced 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 entries to be seen.
never re-uses the same names or id numbers, a large timeout is recommended. 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. The default is 1 minute.
.It Fl usermax Ar max_cache_size .It Fl usermax Ar max_cache_size
Overrides the default upper bound on the cache size. The larger the cache, Overrides the default upper bound on the cache size.
the more kernel memory is used, but the better the performance. If your The larger the cache, the more kernel memory is used, but the better the performance.
system can afford the memory use, make this the sum of the number of If your system can afford the memory use, make this the sum of the number of
entries in your group and password databases. entries in your group and password databases.
The default is 200 entries. The default is 200 entries.
.It Fl verbose .It Fl verbose
@ -98,12 +100,13 @@ on the server instead of the list of groups provided in the RPC authenticator.
This can be used to avoid the 16 group limit for AUTH_SYS. This can be used to avoid the 16 group limit for AUTH_SYS.
.It Ar num_servers .It Ar num_servers
Specifies how many servers to create (max 20). Specifies how many servers to create (max 20).
The default of 4 may be sufficient. You should run enough servers, so that The default of 4 may be sufficient.
You should run enough servers, so that
.Xr ps 1 .Xr ps 1
shows almost no running time for one or two of the slaves after the system 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 has been running for a long period.
performance impact, whereas running too many will only tie up some resources, Running too few will have a major performance impact, whereas running too many
such as a process table entry and swap space. will only tie up some resources, such as a process table entry and swap space.
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr getgrent 3 , .Xr getgrent 3 ,
@ -126,7 +129,8 @@ use
and and
.Xr getpwent 3 .Xr getpwent 3
library calls to resolve requests and will hang if the servers handling library calls to resolve requests and will hang if the servers handling
those requests fail and the library functions don't return. See those requests fail and the library functions don't return.
See
.Xr group 5 .Xr group 5
and and
.Xr passwd 5 .Xr passwd 5

View File

@ -24,7 +24,7 @@
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd Mar 26, 2015 .Dd March 26, 2015
.Dt PMCSTUDY 8 .Dt PMCSTUDY 8
.Os .Os
.Sh NAME .Sh NAME
@ -140,6 +140,6 @@ Run all canned tests.
The The
.Nm .Nm
utility first appeared in utility first appeared in
.Fx 11.0. .Fx 11.0 .
.Sh AUTHORS .Sh AUTHORS
.An Randall Stewart Aq Mt rrs@FreeBSD.org .An Randall Stewart Aq Mt rrs@FreeBSD.org

View File

@ -99,7 +99,8 @@ Debug mode.
.It Fl f Ar firsthop .It Fl f Ar firsthop
Specify how many hops to skip in trace. Specify how many hops to skip in trace.
.It Fl g Ar gateway .It Fl g Ar gateway
Specify intermediate gateway. Please note that Specify intermediate gateway.
Please note that
.Nm .Nm
tries to use routing headers. tries to use routing headers.
.It Fl I .It Fl I
@ -150,7 +151,8 @@ The size of probe packets must be a multiple of 4.
If If
.Ar datalen .Ar datalen
is up to 28, probe packets consist of a SHUTDOWN-ACK chunk possibly bundled is up to 28, probe packets consist of a SHUTDOWN-ACK chunk possibly bundled
with a PAD chunk. For larger probe packets, an INIT chunk is used. with a PAD chunk.
For larger probe packets, an INIT chunk is used.
.It Fl t Ar tclass .It Fl t Ar tclass
.Ar tclass .Ar tclass
specifies the specifies the