Use .Fn for functions and macros with parameters.
authorSascha Wildner <swildner@dragonflybsd.org>
Sun, 23 Nov 2008 21:55:52 +0000 (21:55 +0000)
committerSascha Wildner <swildner@dragonflybsd.org>
Sun, 23 Nov 2008 21:55:52 +0000 (21:55 +0000)
19 files changed:
lib/libc/gen/stringlist.3
lib/libc/i386/sys/i386_get_ioperm.2
lib/libc/net/linkaddr.3
lib/libc/stdlib/getopt_long.3
lib/libstand/libstand.3
lib/libutil/login_cap.3
sbin/ipfw/ipfw.8
share/man/man9/BUS_PRINT_CHILD.9
share/man/man9/VOP_OPENCLOSE.9
share/man/man9/at_exit.9
share/man/man9/bus_generic_attach.9
share/man/man9/bus_generic_detach.9
share/man/man9/bus_generic_print_child.9
share/man/man9/bus_generic_read_ivar.9
share/man/man9/bus_generic_shutdown.9
share/man/man9/microseq.9
share/man/man9/usbdi.9
usr.sbin/rpc.umntall/rpc.umntall.8
usr.sbin/rpc.ypxfrd/rpc.ypxfrd.8

index 1751994..b956c3a 100644 (file)
@@ -34,7 +34,7 @@
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/lib/libc/gen/stringlist.3,v 1.3.2.4 2001/12/14 18:33:51 ru Exp $
-.\" $DragonFly: src/lib/libc/gen/stringlist.3,v 1.3 2008/05/02 02:05:03 swildner Exp $
+.\" $DragonFly: src/lib/libc/gen/stringlist.3,v 1.4 2008/11/23 21:55:52 swildner Exp $
 .\"
 .Dd February 24, 1997
 .Os
@@ -87,7 +87,7 @@ of the current element.
 .El
 .Pp
 The following stringlist manipulation functions are available:
-.Bl -tag -width "sl_init()"
+.Bl -tag -width ".Fn sl_init"
 .It Fn sl_init
 Create a stringlist.
 Returns a pointer to a
index ddf9c60..214b889 100644 (file)
@@ -23,7 +23,7 @@
 .\" SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/lib/libc/i386/sys/i386_get_ioperm.2,v 1.3.2.6 2001/12/14 18:33:54 ru Exp $
-.\" $DragonFly: src/lib/libc/i386/sys/i386_get_ioperm.2,v 1.2 2003/06/17 04:26:43 dillon Exp $
+.\" $DragonFly: src/lib/libc/i386/sys/i386_get_ioperm.2,v 1.3 2008/11/23 21:55:52 swildner Exp $
 .\"
 .Dd July 27, 1998
 .Os
@@ -72,7 +72,9 @@ or
 .Fa length
 arguments.
 .It Bq Er EPERM
-The caller of i386_set_ioperm was not the superuser.
+The caller of
+.Fn i386_set_ioperm
+was not the superuser.
 .El
 .Sh SEE ALSO
 .Xr io 4
index 541c6ce..8f969d4 100644 (file)
@@ -34,7 +34,7 @@
 .\"
 .\"     From: @(#)linkaddr.3   8.1 (Berkeley) 7/28/93
 .\" $FreeBSD: src/lib/libc/net/linkaddr.3,v 1.8.2.4 2001/12/14 18:33:55 ru Exp $
-.\" $DragonFly: src/lib/libc/net/linkaddr.3,v 1.2 2003/06/17 04:26:44 dillon Exp $
+.\" $DragonFly: src/lib/libc/net/linkaddr.3,v 1.3 2008/11/23 21:55:52 swildner Exp $
 .\"
 .Dd June 17, 1996
 .Dt LINK_ADDR 3
@@ -120,7 +120,8 @@ and
 functions appeared in
 .Bx 4.3 Reno  .
 .Sh BUGS
-The returned values for link_ntoa
+The returned values for
+.Fn link_ntoa
 reside in a static memory area.
 .Pp
 The function
index 757d916..e67e8c9 100644 (file)
@@ -1,5 +1,5 @@
 .\"    $NetBSD: getopt_long.3,v 1.14 2003/08/07 16:43:40 agc Exp $
-.\"    $DragonFly: src/lib/libc/stdlib/getopt_long.3,v 1.6 2007/05/12 21:22:10 swildner Exp $
+.\"    $DragonFly: src/lib/libc/stdlib/getopt_long.3,v 1.7 2008/11/23 21:55:52 swildner Exp $
 .\"
 .\" Copyright (c) 1988, 1991, 1993
 .\"    The Regents of the University of California.  All rights reserved.
@@ -205,16 +205,20 @@ returns '?'
 .It NetBSD
 returns ':' (since
 .Nx Ap s
-getopt does).
+.Fn getopt
+does).
 .El
 .It Li o
-handling of --a in getopt:
+handling of --a in
+.Fn getopt :
 .Bl -tag -width "NetBSD"
 .It Li GNU
 parses this as option '-', option 'a'.
 .It Li NetBSD
 parses this as '--', and returns \-1 (ignoring the a).
-(Because the original getopt does.)
+(Because the original
+.Fn getopt
+does.)
 .El
 .It Li o
 setting of optopt for long options with flag !=
@@ -226,7 +230,10 @@ sets optopt to val.
 sets optopt to 0 (since val would never be returned).
 .El
 .It Li o
-handling of -W with W; in option string in getopt (not getopt_long):
+handling of -W with W; in option string in
+.Fn getopt
+(not
+.Fn getopt_long ) :
 .Bl -tag -width "NetBSD"
 .It Li GNU
 causes a segfault.
index 1dd319f..d903163 100644 (file)
@@ -23,7 +23,7 @@
 .\" SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/lib/libstand/libstand.3,v 1.5.2.11 2002/06/26 19:14:43 schweikh Exp $
-.\" $DragonFly: src/lib/libstand/libstand.3,v 1.8 2008/05/02 02:05:04 swildner Exp $
+.\" $DragonFly: src/lib/libstand/libstand.3,v 1.9 2008/11/23 21:55:52 swildner Exp $
 .\"
 .Dd September 13, 2004
 .Dt LIBSTAND 3
@@ -147,7 +147,7 @@ may be specified to refuse all attempts to set a variable.
 The unset hook is invoked when an attempt is made to unset a variable.
 If it
 returns zero, the  variable will be unset.  The predefined function
-.Fa env_nounset
+.Fn env_nounset
 may be used to prevent a variable being unset.
 .El
 .Sh STANDARD LIBRARY SUPPORT
index 06af10f..839b425 100644 (file)
@@ -18,7 +18,7 @@
 .\"    conditions are met.
 .\"
 .\" $FreeBSD: src/lib/libutil/login_cap.3,v 1.17.2.8 2002/12/29 16:35:36 schweikh Exp $
-.\" $DragonFly: src/lib/libutil/login_cap.3,v 1.6 2008/10/01 11:01:02 swildner Exp $
+.\" $DragonFly: src/lib/libutil/login_cap.3,v 1.7 2008/11/23 21:55:52 swildner Exp $
 .\"
 .Dd December 27, 1996
 .Os
@@ -282,7 +282,7 @@ Memory allocated during retrieval or processing of capability
 tags is automatically reused by subsequent calls to functions
 in this group, or deallocated on calling
 .Fn login_close .
-.Bl -tag -width "login_getcaplist()"
+.Bl -tag -width ".Fn login_setcryptfmt"
 .It Fn login_getcapstr
 This function returns a simple string capability.
 If the string is not found, then the value in
index d4dea43..e4f8706 100644 (file)
@@ -1,6 +1,6 @@
 .\"
 .\" $FreeBSD: src/sbin/ipfw/ipfw.8,v 1.63.2.33 2003/02/04 01:36:02 brueffer Exp $
-.\" $DragonFly: src/sbin/ipfw/ipfw.8,v 1.19 2008/10/03 10:46:41 swildner Exp $
+.\" $DragonFly: src/sbin/ipfw/ipfw.8,v 1.20 2008/11/23 21:55:52 swildner Exp $
 .\"
 .Dd October 3, 2008
 .Dt IPFW 8
@@ -553,7 +553,10 @@ the local routing table for that IP.
 A
 .Ar fwd
 rule will not match layer-2 packets (those received
-on ether_input or ether_output).
+on
+.Fn ether_input
+or
+.Fn ether_output ) .
 .br
 The
 .Cm fwd
index 8c8210c..a586232 100644 (file)
@@ -25,7 +25,7 @@
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/share/man/man9/BUS_PRINT_CHILD.9,v 1.6.2.5 2001/12/17 11:30:18 ru Exp $
-.\" $DragonFly: src/share/man/man9/BUS_PRINT_CHILD.9,v 1.5 2006/05/31 19:06:13 swildner Exp $
+.\" $DragonFly: src/share/man/man9/BUS_PRINT_CHILD.9,v 1.6 2008/11/23 21:55:52 swildner Exp $
 .\"
 .Dd June 16, 1998
 .Dt BUS_PRINT_CHILD 9
 .Fn BUS_PRINT_CHILD "device_t dev" "device_t child"
 .Sh DESCRIPTION
 This is called from system code which prints out a description of a
-device.  It should describe the attachment that the child has with
-the parent.
+device.
+It should describe the attachment that the child has with the parent.
 Please see
 .Xr bus_generic_print_child 9
 for more information regarding the proper formatting of the messages
-printed by BUS_PRINT_CHILD.
+printed by
+.Fn BUS_PRINT_CHILD .
 .Sh RETURN VALUES
 The number of characters output.
 .Sh SEE ALSO
index 97f8733..540f8e8 100644 (file)
@@ -25,7 +25,7 @@
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/share/man/man9/VOP_OPENCLOSE.9,v 1.6.2.2 2001/12/17 11:30:18 ru Exp $
-.\" $DragonFly: src/share/man/man9/VOP_OPENCLOSE.9,v 1.3 2004/06/01 11:36:53 hmp Exp $
+.\" $DragonFly: src/share/man/man9/VOP_OPENCLOSE.9,v 1.4 2008/11/23 21:55:52 swildner Exp $
 .\"
 .Dd July 24, 1996
 .Os
@@ -73,7 +73,7 @@ to be locked on entry and will leave it locked on return.
 expects at least a reference to be associated with the vnode and does not
 care whether the vnode is locked or not.  The lock and reference state is
 left unchanged on return.  Note that
-.Fa vn_close
+.Fn vn_close
 expects an unlocked, referenced vnode and will dereference the vnode prior
 to returning.
 .Sh RETURN VALUES
index aaa1739..8fc5110 100644 (file)
@@ -24,7 +24,7 @@
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/share/man/man9/at_exit.9,v 1.10.2.7 2001/12/17 11:30:18 ru Exp $
-.\" $DragonFly: src/share/man/man9/at_exit.9,v 1.3 2007/06/30 19:03:52 swildner Exp $
+.\" $DragonFly: src/share/man/man9/at_exit.9,v 1.4 2008/11/23 21:55:52 swildner Exp $
 .\" "
 .Dd August 15, 1996
 .Os
@@ -59,7 +59,7 @@ argument as the corresponding call to
 .Fn at_exit .
 .Sh RETURN VALUES
 The
-.Fa at_exit
+.Fn at_exit
 function returns an
 .Va errno ,
 0 meaning success.
index 4059afe..e425cb9 100644 (file)
@@ -25,7 +25,7 @@
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/share/man/man9/bus_generic_attach.9,v 1.3.2.3 2001/12/17 11:30:18 ru Exp $
-.\" $DragonFly: src/share/man/man9/bus_generic_attach.9,v 1.3 2004/06/01 11:36:53 hmp Exp $
+.\" $DragonFly: src/share/man/man9/bus_generic_attach.9,v 1.4 2008/11/23 21:55:52 swildner Exp $
 .\"
 .Dd June 16, 1998
 .Dt BUS_GENERIC_ATTACH 9
@@ -33,7 +33,7 @@
 .Sh NAME
 .Nm bus_generic_attach
 .Nd generic implementation of
-.Dv DEVICE_ATTACH
+.Fn DEVICE_ATTACH
 for busses
 .Sh SYNOPSIS
 .In sys/param.h
index 93ae22f..7ca1330 100644 (file)
@@ -25,7 +25,7 @@
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/share/man/man9/bus_generic_detach.9,v 1.3.2.3 2001/12/17 11:30:18 ru Exp $
-.\" $DragonFly: src/share/man/man9/bus_generic_detach.9,v 1.3 2004/06/01 11:36:53 hmp Exp $
+.\" $DragonFly: src/share/man/man9/bus_generic_detach.9,v 1.4 2008/11/23 21:55:52 swildner Exp $
 .\"
 .Dd June 16, 1998
 .Dt BUS_GENERIC_DETACH 9
@@ -33,7 +33,7 @@
 .Sh NAME
 .Nm bus_generic_detach
 .Nd generic implementation of
-.Dv DEVICE_DETACH
+.Fn DEVICE_DETACH
 for busses
 .Sh SYNOPSIS
 .In sys/param.h
index 9e1a45f..5e15c01 100644 (file)
@@ -25,7 +25,7 @@
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/share/man/man9/bus_generic_print_child.9,v 1.5.2.4 2001/12/17 11:30:18 ru Exp $
-.\" $DragonFly: src/share/man/man9/bus_generic_print_child.9,v 1.4 2006/02/17 19:37:10 swildner Exp $
+.\" $DragonFly: src/share/man/man9/bus_generic_print_child.9,v 1.5 2008/11/23 21:55:52 swildner Exp $
 .\"
 .Dd June 16, 1998
 .Dt BUS_GENERIC_PRINT_CHILD 9
@@ -47,10 +47,11 @@ following would be printed:
 .Pp
 foo0: <FooCard 1234> on bar0
 .Pp
-bus_generic_print_child itself calls two functions
+.Fn bus_generic_print_child
+itself calls two functions ,
 .Fn bus_print_child_header
 and
-.Fn bus_print_child_footer
+.Fn bus_print_child_footer .
 The former prints "foo0: <FooCard 1234>" and the latter "on bar0".
 These routines should be used if possible in your own code if
 .Fn bus_generic_print_child
index d1a63bf..de7b7c0 100644 (file)
@@ -25,7 +25,7 @@
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/share/man/man9/bus_generic_read_ivar.9,v 1.4.2.4 2001/12/17 11:30:18 ru Exp $
-.\" $DragonFly: src/share/man/man9/bus_generic_read_ivar.9,v 1.3 2004/06/01 11:36:53 hmp Exp $
+.\" $DragonFly: src/share/man/man9/bus_generic_read_ivar.9,v 1.4 2008/11/23 21:55:52 swildner Exp $
 .\"
 .Dd June 16, 1998
 .Dt BUS_GENERIC_READ_IVAR 9
@@ -34,9 +34,9 @@
 .Nm bus_generic_read_ivar ,
 .Nm bus_generic_write_ivar
 .Nd generic implementation of
-.Dv BUS_READ_IVAR
+.Fn BUS_READ_IVAR
 and
-.Dv BUS_WRITE_IVAR
+.Fn BUS_WRITE_IVAR
 for busses
 .Sh SYNOPSIS
 .In sys/param.h
index 12cf2ac..1001517 100644 (file)
@@ -25,7 +25,7 @@
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/share/man/man9/bus_generic_shutdown.9,v 1.3.2.3 2001/12/17 11:30:18 ru Exp $
-.\" $DragonFly: src/share/man/man9/bus_generic_shutdown.9,v 1.3 2004/06/01 11:36:53 hmp Exp $
+.\" $DragonFly: src/share/man/man9/bus_generic_shutdown.9,v 1.4 2008/11/23 21:55:52 swildner Exp $
 .\"
 .Dd June 16, 1998
 .Dt BUS_GENERIC_SHUTDOWN 9
@@ -33,7 +33,7 @@
 .Sh NAME
 .Nm bus_generic_shutdown
 .Nd generic implementation of
-.Dv DEVICE_SHUTDOWN
+.Fn DEVICE_SHUTDOWN
 for busses
 .Sh SYNOPSIS
 .In sys/param.h
index 9473e1d..09433bc 100644 (file)
@@ -23,7 +23,7 @@
 .\" SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/share/man/man9/microseq.9,v 1.9.2.6 2002/12/29 16:35:39 schweikh Exp $
-.\" $DragonFly: src/share/man/man9/microseq.9,v 1.4 2006/10/14 23:46:23 swildner Exp $
+.\" $DragonFly: src/share/man/man9/microseq.9,v 1.5 2008/11/23 21:55:52 swildner Exp $
 .\"
 .Dd June 6, 1998
 .Dt MICROSEQ 9
@@ -263,7 +263,9 @@ This instruction is mandatory.
 This
 is the only way for the microsequencer to detect the end of the microsequence.
 The return code is returned in the integer pointed by the (int *) parameter
-of the ppb_MS_microseq().
+of the
+.Fn ppb_MS_microseq
+function.
 .Pp
 Parameter:
 .Bl -enum -offset indent
@@ -457,7 +459,9 @@ For example,
 Here, some parameters are undefined and must be filled before executing
 the microsequence.
 In order to initialize each microsequence, one
-should use the ppb_MS_init_msq() function like this:
+should use the
+.Fn ppb_MS_init_msq
+function like this:
 .Bd -literal
      ppb_MS_init_msq(select_microseq, 2,
                     SELECT_TARGET, 1 << target,
index 98d86de..2409300 100644 (file)
@@ -24,7 +24,7 @@
 .\" SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/share/man/man9/usbdi.9,v 1.2 2006/12/14 14:33:13 mpp Exp $
-.\" $DragonFly: src/share/man/man9/usbdi.9,v 1.2 2008/02/09 09:32:05 swildner Exp $
+.\" $DragonFly: src/share/man/man9/usbdi.9,v 1.3 2008/11/23 21:55:52 swildner Exp $
 .Dd December 30, 2005
 .Os
 .Dt USBDI 9
@@ -890,7 +890,7 @@ parameter should point at a completed
 .Vt usb_device_request_t
 structure.
 The function
-.Fa usbd_setup_isoc_xfer
+.Fn usbd_setup_isoc_xfer
 initializes a transfer for an isochronous pipe.
 .Pp
 The function
index 47efbd9..f08309e 100644 (file)
@@ -24,7 +24,7 @@
 .\" SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/usr.sbin/rpc.umntall/rpc.umntall.8,v 1.6.2.3 2003/03/11 22:31:32 trhodes Exp $
-.\" $DragonFly: src/usr.sbin/rpc.umntall/rpc.umntall.8,v 1.4 2006/02/17 19:40:24 swildner Exp $
+.\" $DragonFly: src/usr.sbin/rpc.umntall/rpc.umntall.8,v 1.5 2008/11/23 21:55:52 swildner Exp $
 .\"
 .Dd November 17, 1999
 .Dt RPC.UMNTALL 8
@@ -110,9 +110,11 @@ option.
 Verbose, additional information is printed for each processed mounttab
 entry.
 .It Fl f
-Fast mode.  The resolver timeout is reduced to 4 seconds and the
-pmap_getport() timeout is reduced from 60 seconds to 3.  This option
-is used when
+Fast mode.
+The resolver timeout is reduced to 4 seconds and the
+.Fn pmap_getport()
+timeout is reduced from 60 seconds to 3.
+This option is used when
 .Nm
 is used in the boot sequence to facilitate booting.
 .El
index a610d06..149586d 100644 (file)
@@ -29,7 +29,7 @@
 .\" SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/usr.sbin/rpc.ypxfrd/rpc.ypxfrd.8,v 1.9.2.3 2003/03/11 22:31:32 trhodes Exp $
-.\" $DragonFly: src/usr.sbin/rpc.ypxfrd/rpc.ypxfrd.8,v 1.6 2007/05/13 22:25:42 swildner Exp $
+.\" $DragonFly: src/usr.sbin/rpc.ypxfrd/rpc.ypxfrd.8,v 1.7 2008/11/23 21:55:52 swildner Exp $
 .\"
 .Dd June 2, 1996
 .Dt RPC.YPXFRD 8
@@ -56,7 +56,9 @@ to inform the slave servers to start a transfer.
 The slave servers invoke
 .Xr ypxfr 8 ,
 which reads the entire contents of a map from the master server
-using the yp_all() function.
+using the
+.Fn yp_all
+function.
 .It
 The
 .Xr ypxfr 8