summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2006-09-30 16:01:33 +0000
committerru <ru@FreeBSD.org>2006-09-30 16:01:33 +0000
commit17dd6a0fc1edcdb968f8b1e749c34379b5aa08b6 (patch)
tree9159495c6750d9737bb987947b9f4d11865946ea
parent02f942de1f0ea8f1c26b9ffe2abc02ac35ebb597 (diff)
downloadFreeBSD-src-17dd6a0fc1edcdb968f8b1e749c34379b5aa08b6.zip
FreeBSD-src-17dd6a0fc1edcdb968f8b1e749c34379b5aa08b6.tar.gz
Revise markup.
-rw-r--r--share/man/man5/bluetooth.device.conf.531
-rw-r--r--share/man/man5/ext2fs.56
-rw-r--r--share/man/man5/freebsd-update.conf.516
-rw-r--r--share/man/man5/linsysfs.540
-rw-r--r--share/man/man5/mqueuefs.562
-rw-r--r--share/man/man5/reiserfs.59
6 files changed, 95 insertions, 69 deletions
diff --git a/share/man/man5/bluetooth.device.conf.5 b/share/man/man5/bluetooth.device.conf.5
index 7d66dae..f2004eb 100644
--- a/share/man/man5/bluetooth.device.conf.5
+++ b/share/man/man5/bluetooth.device.conf.5
@@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd Dec 1, 2005
+.Dd December 1, 2005
.Dt BLUETOOTH.DEVICE.CONF 5
.Os
.Sh NAME
@@ -40,7 +40,7 @@ to basic
syntax.
Even though Bluetooth device are not exactly shell scripts,
they are parsed and passed through shell
-.Cm eval
+.Ic eval
command.
This makes it possible to use various shell tricks in the Bluetooth device
configuration files.
@@ -62,10 +62,10 @@ file apply to every Bluetooth device connected to the system.
.Pp
Configuration parameters overrides for the specific Bluetooth device
should be placed in the
-.Pa /etc/bluetooth/DEVICE_DRIVER_NAME.conf
+.Pa /etc/bluetooth/ Ns Ar DEVICE_DRIVER_NAME Ns Pa .conf
file.
Where
-.Va DEVICE_DRIVER_NAME
+.Ar DEVICE_DRIVER_NAME
is the device driver name of the Bluetooth device.
.Pp
The following list provides a name and short description for each
@@ -90,7 +90,7 @@ The
parameter is used to indicate the capabilities of the device to
other devices.
For more details see
-https://www.bluetooth.org/foundry/assignnumb/document/baseband.
+.Pa https://www.bluetooth.org/foundry/assignnumb/document/baseband .
.It Va connectable
.Pq Vt bool
The
@@ -153,21 +153,24 @@ such devices will fail.
If
.Va role switch
is disabled then accepting device will remain Slave.
-.Sh EXAMPLES
-.Bl -tag -width ".Pa /etc/bluetooth/ubt0.conf"
-.It Pa /etc/bluetooth/ubt0.conf
-file should be used to specify configuration parameters overrides for the
-first USB Bluetooth device
-.Pq device driver name is ubt0 .
-.It Pa /etc/bluetooth/ubt1.conf
-file should be used to specify configuration parameters overrides for the
-second USB Bluetooth device.
.El
.Sh FILES
.Bl -tag -width ".Pa /etc/defaults/bluetooth.device.conf" -compact
.It Pa /etc/defaults/bluetooth.device.conf
.It Pa /etc/rc.d/bluetooth
.El
+.Sh EXAMPLES
+The
+.Pa /etc/bluetooth/ubt0.conf
+file should be used to specify configuration parameters overrides for the
+first USB Bluetooth device
+(device driver name is
+.Li ubt0 ) .
+.Pp
+The
+.Pa /etc/bluetooth/ubt1.conf
+file should be used to specify configuration parameters overrides for the
+second USB Bluetooth device.
.Sh SEE ALSO
.Xr ng_bt3c 4 ,
.Xr ng_h4 4 ,
diff --git a/share/man/man5/ext2fs.5 b/share/man/man5/ext2fs.5
index 48a5e82..a74e599 100644
--- a/share/man/man5/ext2fs.5
+++ b/share/man/man5/ext2fs.5
@@ -47,8 +47,7 @@ The
driver will permit the
.Fx
kernel to access
-.Tn
-Ext2
+.Tn Ext2
file systems.
.Sh EXAMPLES
To mount a
@@ -63,8 +62,9 @@ volume located on
.Xr fstab 5 ,
.Xr mount 8
.Sh HISTORY
+The
.Nm
-first appeared in
+driver first appeared in
.Fx 2.2 .
.Sh AUTHORS
.An -nosplit
diff --git a/share/man/man5/freebsd-update.conf.5 b/share/man/man5/freebsd-update.conf.5
index 776c728..b5352c5 100644
--- a/share/man/man5/freebsd-update.conf.5
+++ b/share/man/man5/freebsd-update.conf.5
@@ -30,7 +30,7 @@
.Os FreeBSD
.Sh NAME
.Nm freebsd-update.conf
-.Nd configuration file for
+.Nd configuration file for
.Xr freebsd-update 8
.Sh DESCRIPTION
The
@@ -38,18 +38,18 @@ The
file controls the behaviour of the
.Xr freebsd-update 8
utility.
-The file contains lines consisting of a case-sensitive option name and
+The file contains lines consisting of a case-sensitive option name and
zero or more parameters.
Empty lines and any part of a line following a
.Ql #
character are ignored.
-Unless stated otherwise, specifying an option multiple times is an
+Unless stated otherwise, specifying an option multiple times is an
error.
.Pp
The possible options and their meanings are as follows:
.Pp
.Bl -tag -width "KeepModifiedMetadata"
-.It Cm KeyPrint
+.It Cm KeyPrint
The single parameter following this keyword is the SHA256 hash
of the RSA key which will be trusted to sign updates.
.It Cm ServerName
@@ -59,7 +59,8 @@ server or server pool from which updates will be downloaded.
The parameters following this keyword are the components or
sub-components of
.Fx
-which will be updated. The components are
+which will be updated.
+The components are
.Dq src
(source code),
.Dq world
@@ -112,7 +113,8 @@ or
and specifies whether
.Cm freebsd-update
is allowed to create new files, directories, and symlinks if
-these are part of updates downloaded. Note that
+these are part of updates downloaded.
+Note that
.Cm freebsd-update
will not re-add files which have been deleted from a
.Fx
@@ -145,7 +147,7 @@ Default location of the
configuration file.
.El
.Sh SEE ALSO
+.Xr sha256 1 ,
.Xr freebsd-update 8
-.Xr sha256 8
.Sh AUTHORS
.An Colin Percival Aq cperciva@FreeBSD.org
diff --git a/share/man/man5/linsysfs.5 b/share/man/man5/linsysfs.5
index e1e6d85..75806ba 100644
--- a/share/man/man5/linsysfs.5
+++ b/share/man/man5/linsysfs.5
@@ -14,25 +14,31 @@
linsys /compat/linux/sys linsysfs rw 0 0
.Ed
.Sh DESCRIPTION
-The Linux system file system, or
+The
+.Tn Linux
+system file system, or
.Nm ,
-emulates a subset of the Linux sys file system and is required for
-the complete operation of some Linux binaries.
+emulates a subset of the
+.Tn Linux
+sys file system and is required for
+the complete operation of some
+.Tn Linux
+binaries.
.Pp
The
.Nm
provides a two-level view of devices.
At the highest level, PCI devices themselves are named, according to
their bus, slot and function in the system hierachy.
-PCI storage devices are listed in the scsi_host class with a device sym-link
+PCI storage devices are listed in the
+.Pa scsi_host
+class with a device symlink
to the PCI directories of the devices.
.Pp
Each device node is a directory containing some files and directories:
-.Bl -tag -width status
+.Bl -tag -width ".Pa status"
.It Pa host
-A place holder for storage
-.Pa host
-information.
+A place holder for storage host information.
.It Pa pci_id
A directory for the
.Pa pci_id
@@ -41,18 +47,18 @@ for a PCI bridge.
.El
.Pp
Each host node of scsi_host is a directory containing some files and directories:
-.Bl -tag -width proc_name
+.Bl -tag -width ".Pa proc_name"
.It Pa proc_name
-The Linux registered driver name for these devices.
+The
+.Tn Linux
+registered driver name for these devices.
.It Pa device
-A sym-link to the PCI
-.Pa device
-directory.
+A symlink to the PCI device directory.
.El
.Sh FILES
-.Bl -tag -width /compat/linux/sys/devices/pci0000:00 -compact
+.Bl -tag -width ".Pa /compat/linux/sys/devices/pci0000:00" -compact
.It Pa /compat/linux/sys
-The normal mount point for the
+The normal mount point for
.Nm .
.It Pa /compat/linux/sys/class/scsi_host
The storage host node.
@@ -67,13 +73,13 @@ The PCI device hierarchy node.
.Sh HISTORY
The
.Nm
-first appeared in
+driver first appeared in
.Fx 7.0 .
.Sh AUTHORS
.An -nosplit
The
.Nm
-was derived from
+driver was derived from
.Nm linprocfs
by
.An Doug Ambrisko .
diff --git a/share/man/man5/mqueuefs.5 b/share/man/man5/mqueuefs.5
index 164e6f3..5525d8a 100644
--- a/share/man/man5/mqueuefs.5
+++ b/share/man/man5/mqueuefs.5
@@ -26,6 +26,7 @@
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
+.\"
.Dd November 30, 2005
.Dt MQUEUEFS 5
.Os
@@ -33,29 +34,36 @@
.Nm mqueuefs
.Nd POSIX message queue file system
.Sh SYNOPSIS
-To link into kernel
-.Dl Cd "options P1003_1B_MQUEUE"
+To link into kernel:
+.Pp
+.D1 Cd "options P1003_1B_MQUEUE"
.Pp
-To load as a kernel loadable module
-.Dl kldload mqueuefs
+To load as a kernel loadable module:
+.Pp
+.Dl "kldload mqueuefs"
.Sh DESCRIPTION
The
.Nm
module will permit the
.Fx
-kernel to support POSIX message queue.
-The module contains system call to manipulate POSIX message queue.
+kernel to support
+.Tn POSIX
+message queue.
+The module contains system calls to manipulate
+.Tn POSIX
+message queues.
It also contains a file system to implement a view for all message queues of
-the system. This helps users to keep track of their message queues and make
+the system.
+This helps users to keep track of their message queues and make
it more easily usable without having to invent additional tools.
.Pp
-The most common usage follows:
+The most common usage is as follows:
.Pp
.Dl "mount -t mqueuefs null /mnt/mqueue"
.Pp
where
.Pa /mnt/mqueue
-is a mount point.
+is a mount point.
.Pp
It is possible to define an entry in
.Pa /etc/fstab
@@ -64,7 +72,9 @@ that looks similar to:
null /mnt/mqueue mqueuefs rw 0 0
.Ed
.Pp
-This will mount mqueuefs at the
+This will mount
+.Nm
+at the
.Pa /mnt/mqueue
mount point during system boot.
Using
@@ -77,34 +87,38 @@ for more information on
.Fx
directory layout.
.Pp
-Some common tools can be used on the file system, e.g:
+Some common tools can be used on the file system, e.g.:
.Xr cat 1 ,
.Xr chmod 1 ,
.Xr chown 8 ,
.Xr ls 1 ,
.Xr rm 1 ,
-etcs.
-To only use the message queue system call, it is not necessary for
+etc.
+To use only the message queue system calls, it is not necessary for
user to mount the file system, just load the module or compile it
-into the kernel. Manually creating a file, for example, touch
-.Pa /mnt/mqueue/myqueue ,
-will create a message queue named myqueue in the kernel, default
-message queue attributes will be applied to the queue, it is not
-advised to use this method to create a queue, it is better to use
+into the kernel.
+Manually creating a file, for example,
+.Dq Li "touch /mnt/mqueue/myqueue" ,
+will create a message queue named
+.Pa myqueue
+in the kernel, default
+message queue attributes will be applied to the queue.
+It is not
+advised to use this method to create a queue;
+it is better to use the
.Xr mq_open 2
-system call to create the queue, the
-.Xr mq_open 2
-allows user to specify differnt attributes.
+system call to create a queue as it
+allows the user to specify different attributes.
.Pp
To see the queue's attributes, just read the file:
.Pp
-.Dl cat /mnt/mqueue/myqueue
+.Dl "cat /mnt/mqueue/myqueue"
.Sh SEE ALSO
-.Xr mq_open 2 ,
.Xr mount 2 ,
+.Xr mq_open 2 ,
.Xr unmount 2 ,
.Xr mount 8 ,
-.Xr umount 8 .
+.Xr umount 8
.Sh AUTHORS
This manual page was written by
.An "David Xu" Aq davidxu@FreeBSD.org .
diff --git a/share/man/man5/reiserfs.5 b/share/man/man5/reiserfs.5
index 60f2493..b7445a6 100644
--- a/share/man/man5/reiserfs.5
+++ b/share/man/man5/reiserfs.5
@@ -47,8 +47,7 @@ The
driver will permit the
.Fx
kernel to access
-.Tn
-ReiserFS
+.Tn ReiserFS
file systems.
.Sh EXAMPLES
To mount a
@@ -63,10 +62,12 @@ volume located on
.Xr fstab 5 ,
.Xr mount 8
.Sh CAVEATS
-Currently, read-only access is supported for ReiserFS volumes.
-Writing to a volume is currently unsupported.
+Currently, only read-only access is supported for ReiserFS volumes,
+writing to a volume is not supported.
.Sh HISTORY
+The
.Nm
+file system support
first appeared in
.Fx 6.0 .
.Sh AUTHORS
OpenPOWER on IntegriCloud