d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix a few mandoc issues

Browse Source 
- 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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
sbin/devmatch/devmatch.8
View File

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

3
usr.bin/chat/chat.8
View File

@ -291,7 +291,8 @@ The
.Dv SAY
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
know what is happening. An example is:
know what is happening.
An example is:
.Bd -literal -offset indent
ABORT BUSY
ECHO OFF

7
usr.bin/setchannel/setchannel.1
View File

@ -61,8 +61,8 @@ 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.
Select geometry.
The first resolution is for NTSC, the second for PAL.
.Pp
VCD: 352x240 or 352x288
SVCD: 480x480 or 480x576
@ -91,7 +91,8 @@ Frequency in MHz (must include decimal point).
.Sh HISTORY
The
.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
program first appeared in the FreeBSD Ports collection in October 2004.
.Sh AUTHORS

20
usr.bin/tftp/tftp.1
View File

@ -74,7 +74,8 @@ Shorthand for "mode binary"
Sets the TFTP blksize option in TFTP Read Request or Write Request packets
to
.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
will be used.
.Pp
@ -82,8 +83,8 @@ will be used.
Sets the TFTP blksize2 option in TFTP Read Request or Write Request packets
to
.Ar [size] .
Values are restricted to powers of 2 between 8 and 32768. This is a
non-standard TFTP option.
Values are restricted to powers of 2 between 8 and 32768.
This is a non-standard TFTP option.
.Pp
.It Cm connect Ar host Op Ar port
Set the
@ -109,7 +110,8 @@ or
commands.
.Pp
.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
can be one of
.Cm packet , simple , options ,
@ -156,7 +158,8 @@ The default is
.It Cm packetdrop [arg]
Randomly drop
.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
.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
@ -178,7 +181,8 @@ see the example under the
command.
.Pp
.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
are
.Cm on
@ -198,8 +202,8 @@ Set the per-packet retransmission timeout, in seconds.
.Pp
.It Cm rollover [arg]
Specify the rollover option in TFTP Read Request or Write
Request packets. After 65535 packets have been transmitted, set the block
counter to
Request packets.
After 65535 packets have been transmitted, set the block counter to
.Ar arg .
Valid values of
.Ar arg

161
usr.sbin/ctladm/ctladm.8
View File

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

2
usr.sbin/extattrctl/extattrctl.8
View File

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

27
usr.sbin/i2c/i2c.8
View File

@ -55,8 +55,8 @@
The
.Nm
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
I2C controller.
on the I2C bus.
It can also scan the bus for available devices and reset the I2C controller.
.Pp
The options are as follows:
.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
Great care must be taken when manipulating slave I2C devices with the
.Nm
utility. Often times important configuration data for the system is kept in
non-volatile but write enabled memories located on the I2C bus, for example
Ethernet hardware addresses, RAM module parameters (SPD), processor reset
configuration word etc.
utility.
Often times important configuration data for the system is kept in non-volatile
but write enabled memories located on the I2C bus, for example Ethernet hardware
addresses, RAM module parameters (SPD), processor reset configuration word etc.
.Pp
It is very easy to render the whole system unusable when such configuration
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.
.Pp
Also avoid ungraceful interrupting of an ongoing transaction on the I2C bus,
as it can lead to potentially dangerous effects. Consider the following
scenario: when the host CPU is reset (for whatever reason) in the middle of a
started I2C transaction, the I2C slave device could be left in write mode
waiting for data or offset to arrive. When the CPU reinitializes itself and
talks to this I2C slave device again, the commands and other control info it
sends are treated by the slave device as data or offset it was waiting for,
and there's great potential for corruption if such a write is performed.
as it can lead to potentially dangerous effects.
Consider the following scenario: when the host CPU is reset (for whatever reason)
in the middle of a started I2C transaction, the I2C slave device could be left
in write mode waiting for data or offset to arrive.
When the CPU reinitializes itself and talks to this I2C slave device again,
the commands and other control info it sends are treated by the slave device
as data or offset it was waiting for, and there's great potential for
corruption if such a write is performed.
.Sh EXAMPLES
.Bl -bullet
.It

30
usr.sbin/mountd/exports.5
View File

@ -28,7 +28,7 @@
.\" @(#)exports.5 8.3 (Berkeley) 3/29/95
.\" $FreeBSD$
.\"
.Dd Feb 11, 2019
.Dd February 11, 2019
.Dt EXPORTS 5
.Os
.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.
For file systems other than ZFS,
this location can be any directory and does not
need to be within an exported file system. If it is not in an exported
file system, a very limited set of operations are permitted, so that an
NFSv4 client can traverse the tree to an exported file system.
need to be within an exported file system.
If it is not in an exported file system, a very limited set of operations
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
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
@ -330,10 +331,11 @@ mount points.
The
.Fl sec
option on these line(s) specifies what security flavors may be used for
NFSv4 operations that do not use file handles. Since these operations
(SetClientID, SetClientIDConfirm, Renew, DelegPurge and ReleaseLockOnwer)
allocate/modify state in the server, it is possible to restrict some clients to
the use of the krb5[ip] security flavors, via this option.
NFSv4 operations that do not use file handles.
Since these operations (SetClientID, SetClientIDConfirm, Renew, DelegPurge
and ReleaseLockOnwer) allocate/modify state in the server, it is possible
to restrict some clients to the use of the krb5[ip] security flavors,
via this option.
See the
.Sx EXAMPLES
section below.
@ -507,12 +509,13 @@ V4: /wingsdl/nfsv4
.Ed
.Pp
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.
.Pp
The exported directories' paths are used for both v3 and v4.
However, they are interpreted differently for v3 and v4. A client
mount command for usr-ports would use the server-absolute name when
However, they are interpreted differently for v3 and v4.
A client mount command for usr-ports would use the server-absolute name when
using nfsv3:
.Bd -literal -offset indent
mount server:/wingsdl/nfsv4/usr-ports /mnt/tmp
@ -525,8 +528,9 @@ mount server:/usr-ports /mnt/tmp
.Ed
.Pp
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
latter will only ever do a v4 mount.
both v3 and v4.
The former will only ever do a v3 mount and the latter will only ever
do a v4 mount.
.Pp
Note that due to different mount behavior between NFSv3 and NFSv4 a
NFSv4 mount request for a directory that the client does not have

34
usr.sbin/nfsuserd/nfsuserd.8
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
this is being used for any version of NFS.
.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.
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:
@ -72,13 +73,14 @@ reported by
Overrides the default timeout for cache entries, in minutes.
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.
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
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
@ -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.
.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
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.
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 getgrent 3 ,
@ -126,7 +129,8 @@ use
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
those requests fail and the library functions don't return.
See
.Xr group 5
and
.Xr passwd 5

2
usr.sbin/pmcstudy/pmcstudy.8
View File

@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd Mar 26, 2015
.Dd March 26, 2015
.Dt PMCSTUDY 8
.Os
.Sh NAME

6
usr.sbin/traceroute6/traceroute6.8
View File

@ -99,7 +99,8 @@ Debug mode.
.It Fl f Ar firsthop
Specify how many hops to skip in trace.
.It Fl g Ar gateway
Specify intermediate gateway. Please note that
Specify intermediate gateway.
Please note that
.Nm
tries to use routing headers.
.It Fl I
@ -150,7 +151,8 @@ The size of probe packets must be a multiple of 4.
If
.Ar datalen
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
.Ar tclass
specifies the