Date: Mon, 22 Apr 2002 21:13:56 +0300 From: Giorgos Keramidas <keramida@FreeBSD.org> To: audit@FreeBSD.org Subject: RFC: `The .Fn function' in library manpages. Message-ID: <20020422181355.GA2290@hades.hell.gr>
next in thread | raw e-mail | index | archive | help
Looking at the recent work of Philippe Charnier, changing `.Nm [A-Z]' manpages, I started doing something similar to the manpages of src/lib earlier this afternoon. Do you think changes like the ones shown in the patch below are worth the effort? This patch cleans up src/lib/libc/compat-43 from lines that match '^\.Fn [A-Z]'. %%% Index: creat.2 =================================================================== RCS file: /home/ncvs/src/lib/libc/compat-43/creat.2,v retrieving revision 1.9 diff -u -r1.9 creat.2 --- creat.2 1 Oct 2001 16:08:50 -0000 1.9 +++ creat.2 22 Apr 2002 17:05:06 -0000 @@ -50,7 +50,9 @@ .Ef .Xr open 2 . .Pp -.Fn Creat +The +.Fn +function is the same as: .Bd -literal -offset indent open(path, O_CREAT | O_TRUNC | O_WRONLY, mode); Index: gethostid.3 =================================================================== RCS file: /home/ncvs/src/lib/libc/compat-43/gethostid.3,v retrieving revision 1.10 diff -u -r1.10 gethostid.3 --- gethostid.3 1 Oct 2001 16:08:50 -0000 1.10 +++ gethostid.3 22 Apr 2002 17:05:23 -0000 @@ -48,14 +48,18 @@ .Ft void .Fn sethostid "long hostid" .Sh DESCRIPTION -.Fn Sethostid +The +.Fn sethostid +function establishes a 32-bit identifier for the current processor that is intended to be unique among all UNIX systems in existence. This is normally a DARPA Internet address for the local machine. This call is allowed only to the super-user and is normally performed at boot time. .Pp -.Fn Gethostid +The +.Fn gethostid +function returns the 32-bit identifier for the current processor. .Pp This function has been deprecated. Index: killpg.2 =================================================================== RCS file: /home/ncvs/src/lib/libc/compat-43/killpg.2,v retrieving revision 1.10 diff -u -r1.10 killpg.2 --- killpg.2 1 Oct 2001 16:08:50 -0000 1.10 +++ killpg.2 22 Apr 2002 17:05:50 -0000 @@ -46,7 +46,9 @@ .Ft int .Fn killpg "pid_t pgrp" "int sig" .Sh DESCRIPTION -.Fn Killpg +The +.Fn killpg +function sends the signal .Fa sig to the process group @@ -68,7 +70,9 @@ .Sh RETURN VALUES .Rv -std killpg .Sh ERRORS -.Fn Killpg +The +.Fn killpg +function will fail and no signal will be sent if: .Bl -tag -width Er .It Bq Er EINVAL Index: sigpause.2 =================================================================== RCS file: /home/ncvs/src/lib/libc/compat-43/sigpause.2,v retrieving revision 1.10 diff -u -r1.10 sigpause.2 --- sigpause.2 1 Oct 2001 16:08:50 -0000 1.10 +++ sigpause.2 22 Apr 2002 17:06:33 -0000 @@ -48,7 +48,9 @@ .Sy This interface is made obsolete by .Xr sigsuspend 2 . .Pp -.Fn Sigpause +The +.Fn +function assigns .Fa sigmask to the set of masked signals @@ -57,7 +59,8 @@ .Fa Sigmask is usually 0 to indicate that no signals are to be blocked. -.Fn Sigpause +The +.Fn always terminates by being interrupted, returning -1 with .Va errno set to @@ -71,7 +74,7 @@ .Xr sigvec 2 .Sh HISTORY The -.Fn sigpause +.Fn function call appeared in .Bx 4.2 and has been deprecated. Index: sigsetmask.2 =================================================================== RCS file: /home/ncvs/src/lib/libc/compat-43/sigsetmask.2,v retrieving revision 1.12 diff -u -r1.12 sigsetmask.2 --- sigsetmask.2 1 Oct 2001 16:08:50 -0000 1.12 +++ sigsetmask.2 22 Apr 2002 17:07:00 -0000 @@ -55,13 +55,17 @@ .Ef .Xr sigprocmask 2 . .Pp -.Fn Sigsetmask +The +.Fn sigsetmask +function sets the current signal mask to the specified .Fa mask . Signals are blocked from delivery if the corresponding bit in .Fa mask is a 1. -.Fn Sigblock +The +.Fn sigblock +function adds the signals in the specified .Fa mask to the current signal mask, @@ -80,7 +84,8 @@ .Dv SIGSTOP to be blocked. .Sh RETURN VALUES -.Fn Sigblock +The +.Fn sigblock and .Fn sigsetmask return the previous set of masked signals. Index: sigvec.2 =================================================================== RCS file: /home/ncvs/src/lib/libc/compat-43/sigvec.2,v retrieving revision 1.19 diff -u -r1.19 sigvec.2 --- sigvec.2 1 Oct 2001 16:08:50 -0000 1.19 +++ sigvec.2 22 Apr 2002 17:08:08 -0000 @@ -116,7 +116,9 @@ .Em or Ns 'ing in the signal mask associated with the handler to be invoked. .Pp -.Fn Sigvec +The +.Fn +function assigns a handler for a specific signal. If .Fa vec is non-zero, it @@ -258,7 +260,9 @@ .Sh RETURN VALUES .Rv -std sigvec .Sh ERRORS -.Fn Sigvec +The +.Fn +function will fail and no new signal handler will be installed if one of the following occurs: .Bl -tag -width Er %%% To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-audit" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20020422181355.GA2290>