libc: mdoc cleanup in some system call manual pages.
authorSascha Wildner <saw@online.de>
Tue, 5 Apr 2016 17:41:41 +0000 (19:41 +0200)
committerSascha Wildner <saw@online.de>
Tue, 5 Apr 2016 17:41:41 +0000 (19:41 +0200)
lib/libc/sys/mmap.2
lib/libc/sys/mount.2
lib/libc/sys/shutdown.2
lib/libc/sys/statfs.2

index 3a40d7e..935c074 100644 (file)
@@ -77,7 +77,7 @@ argument by
 .Em or Ns 'ing
 the following values:
 .Pp
-.Bl -tag -width PROT_WRITE -compact
+.Bl -tag -width ".Dv PROT_WRITE" -compact
 .It Dv PROT_NONE
 Pages may not be accessed.
 .It Dv PROT_READ
@@ -98,7 +98,7 @@ Sharing, mapping type and options are specified in the
 argument by
 .Em or Ns 'ing
 the following values:
-.Bl -tag -width MAP_HASSEMAPHORE
+.Bl -tag -width ".Dv MAP_HASSEMAPHORE"
 .It Dv MAP_ANON
 Map anonymous memory not associated with any specific file.
 The file descriptor used for creating
@@ -130,7 +130,11 @@ must be a multiple of the pagesize.
 Try to do a fixed mapping but fail if another mapping already exists in
 the space instead of overwriting the mapping.
 .Pp
-When used with MAP_STACK this flag allows one MAP_STACK mapping to be
+When used with
+.Dv MAP_STACK
+this flag allows one
+.Dv MAP_STACK
+mapping to be
 made within another (typically the master user stack), as long as
 no pages have been faulted in the area requested.
 .It Dv MAP_HASSEMAPHORE
@@ -143,15 +147,16 @@ Causes data dirtied via this VM map to be flushed to physical media
 only when necessary (usually by the pager) rather than gratuitously.
 Typically this prevents the update daemons from flushing pages dirtied
 through such maps and thus allows efficient sharing of memory across
-unassociated processes using a file-backed shared memory map.  Without
+unassociated processes using a file-backed shared memory map.
+Without
 this option any VM pages you dirty may be flushed to disk every so often
 (every 30-60 seconds usually) which can create performance problems if you
 do not need that to occur (such as when you are using shared file-backed
-mmap regions for IPC purposes).  Note that VM/filesystem coherency is
-maintained whether you use
+mmap regions for IPC purposes).
+Note that VM/filesystem coherency is maintained whether you use
 .Dv MAP_NOSYNC
-or not.  This option is not portable
-across
+or not.
+This option is not portable across
 .Ux
 platforms (yet), though some may implement the same behavior
 by default.
@@ -182,13 +187,14 @@ it.
 You can test file fragmentation by observing the KB/t (kilobytes per
 transfer) results from an
 .Dq Li iostat 1
-while reading a large file sequentially, e.g. using
+while reading a large file sequentially, e.g.\* using
 .Dq Li dd if=filename of=/dev/null bs=32k .
 .Pp
 The
 .Xr fsync 2
 function will flush all dirty data and metadata associated with a file,
-including dirty NOSYNC VM data, to physical media.  The
+including dirty NOSYNC VM data, to physical media.
+The
 .Xr sync 8
 command and
 .Xr sync 2
@@ -197,7 +203,8 @@ The
 .Xr msync 2
 system call is obsolete since
 .Bx
-implements a coherent filesystem buffer cache.  However, it may be
+implements a coherent filesystem buffer cache.
+However, it may be
 used to associate dirty VM pages with filesystem buffers and thus cause
 them to be flushed to physical media sooner rather than later.
 .It Dv MAP_PRIVATE
@@ -220,8 +227,8 @@ and
 This option creates
 a memory region that grows to at most
 .Fa len
-bytes in size, starting from the stack top and growing down.  The
-stack top is the starting address returned by the call, plus
+bytes in size, starting from the stack top and growing down.
+The stack top is the starting address returned by the call, plus
 .Fa len
 bytes.
 The bottom of the stack at maximum growth is the starting
@@ -231,7 +238,8 @@ The entire area is reserved from the point of view of other
 .Fn mmap
 calls, even if not faulted in yet.
 .Pp
-WARNING.  We currently allow
+.Em WARNING !
+We currently allow
 .Dv MAP_STACK
 mappings to provide a hint that points within an existing
 .Dv MAP_STACK
@@ -249,21 +257,24 @@ is used, you cannot count on the returned address matching the hint
 you have provided.
 .It Dv MAP_VPAGETABLE
 Memory accessed via this map is not linearly mapped and will be governed
-by a virtual page table.  The base address of the virtual page table may
-be set using
+by a virtual page table.
+The base address of the virtual page table may be set using
 .Xr mcontrol 2
 with
 .Dv MADV_SETMAP .
 Virtual page tables work with anonymous memory but there
 is no way to populate the page table so for all intents and purposes
 .Dv MAP_VPAGETABLE
-can only be used when mapping file descriptors.  Since the kernel will
-update the VPTE_M bit in the virtual page table, the mapping must R+W
+can only be used when mapping file descriptors.
+Since the kernel will update the
+.Dv VPTE_M
+bit in the virtual page table, the mapping must R+W
 even though actual access to the memory will be properly governed by
 the virtual page table.
 .Pp
 Addressable backing store is limited by the range supported in the virtual
-page table entries.  The kernel may implement a page table abstraction capable
+page table entries.
+The kernel may implement a page table abstraction capable
 of addressing a larger range within the backing store then could otherwise
 be mapped into memory.
 .El
index ec0477a..6e21c81 100644 (file)
@@ -27,7 +27,6 @@
 .\"
 .\"     @(#)mount.2    8.3 (Berkeley) 5/24/95
 .\" $FreeBSD: src/lib/libc/sys/mount.2,v 1.20.2.8 2003/01/17 22:02:42 joerg Exp $
-.\" $DragonFly: src/lib/libc/sys/mount.2,v 1.6 2008/02/09 00:10:29 swildner Exp $
 .\"
 .Dd May 24, 1995
 .Dt MOUNT 2
@@ -82,12 +81,13 @@ The following
 .Ar flags
 may be specified to
 suppress default semantics which affect filesystem access.
-.Bl -tag -width MNT_SYNCHRONOUS
+.Bl -tag -width ".Dv MNT_SYNCHRONOUS"
 .It Dv MNT_RDONLY
 The filesystem should be treated as read-only;
 Even the super-user may not write on it.
-Specifying MNT_UPDATE without this option will upgrade
-a read-only filesystem to read/write.
+Specifying
+.Dv MNT_UPDATE
+without this option will upgrade a read-only filesystem to read/write.
 .It Dv MNT_NOEXEC
 Do not allow files to be executed from the filesystem.
 .It Dv MNT_NOSUID
@@ -159,8 +159,11 @@ The
 argument may specify
 .Dv MNT_FORCE
 to specify that the filesystem should be forcibly unmounted or made read-only
-(if MNT_UPDATE and MNT_RDONLY are also specified)
-even if files are still active.
+(if
+.Dv MNT_UPDATE
+and
+.Dv MNT_RDONLY
+are also specified) even if files are still active.
 Active special devices continue to work,
 but any further accesses to any other active files result in errors
 even if the filesystem is later remounted.
index f36bfbe..b40839a 100644 (file)
@@ -27,7 +27,6 @@
 .\"
 .\"     @(#)shutdown.2 8.1 (Berkeley) 6/4/93
 .\" $FreeBSD: src/lib/libc/sys/shutdown.2,v 1.7.2.7 2001/12/14 18:34:01 ru Exp $
-.\" $DragonFly: src/lib/libc/sys/shutdown.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
 .\"
 .Dd February 27, 2001
 .Dt SHUTDOWN 2
@@ -53,7 +52,7 @@ The
 .Fa how
 argument specifies the type of shutdown.
 Possible values are:
-.Bl -tag -width SHUT_RDWR
+.Bl -tag -width ".Dv SHUT_RDWR"
 .It Dv SHUT_RD
 further receives will be disallowed.
 .It Dv SHUT_WR
index 5d36d06..080aa96 100644 (file)
@@ -27,7 +27,6 @@
 .\"
 .\"    @(#)statfs.2    8.5 (Berkeley) 5/24/95
 .\" $FreeBSD: src/lib/libc/sys/statfs.2,v 1.9.2.7 2001/12/14 18:34:01 ru Exp $
-.\" $DragonFly: src/lib/libc/sys/statfs.2,v 1.4 2008/09/28 16:33:35 swildner Exp $
 .\"
 .Dd September 28, 2008
 .Dt STATFS 2
@@ -87,7 +86,7 @@ struct statfs {
 .Ed
 .Pp
 The flags that may be returned include:
-.Bl -tag -width MNT_SYNCHRONOUS
+.Bl -tag -width ".Dv MNT_SYNCHRONOUS"
 .It Dv MNT_RDONLY
 The filesystem is mounted read-only;
 Even the super-user may not write on it.