summaryrefslogtreecommitdiffstats
path: root/lib/libutil
diff options
context:
space:
mode:
authormpp <mpp@FreeBSD.org>1996-12-30 21:08:45 +0000
committermpp <mpp@FreeBSD.org>1996-12-30 21:08:45 +0000
commitb42b04fa8508860f70837f3f765e76184a8b16d7 (patch)
tree3968965035aedf796c52937457a0a72ed13248d9 /lib/libutil
parentb5550d52c4583bdcdd69712ec6ec85f9b5af3750 (diff)
downloadFreeBSD-src-b42b04fa8508860f70837f3f765e76184a8b16d7.zip
FreeBSD-src-b42b04fa8508860f70837f3f765e76184a8b16d7.tar.gz
Spelling/mdoc police.
Diffstat (limited to 'lib/libutil')
-rw-r--r--lib/libutil/login.36
-rw-r--r--lib/libutil/login_tty.310
-rw-r--r--lib/libutil/logout.312
-rw-r--r--lib/libutil/logwtmp.34
-rw-r--r--lib/libutil/pty.333
-rw-r--r--lib/libutil/setproctitle.312
6 files changed, 39 insertions, 38 deletions
diff --git a/lib/libutil/login.3 b/lib/libutil/login.3
index dd326b0..bbb980e 100644
--- a/lib/libutil/login.3
+++ b/lib/libutil/login.3
@@ -23,7 +23,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $Id$
+.\" $Id: login.3,v 1.1 1996/12/29 18:30:38 joerg Exp $
.\" "
.Dd December 29, 1996
.Os
@@ -45,7 +45,7 @@ on the
command line.
.Sh DESCRIPTION
The function
-.Nm login
+.Fn login
records the
.Ar ut
entry being passed into the appropriate slot of the
@@ -63,7 +63,7 @@ None.
.Xr wtmp 5
.Sh BUGS
The interface provided by
-.Nm login
+.Fn login
is rather crude. The caller must know about the details of a
.Va struct utmp .
Some better abstraction needs to be worked out.
diff --git a/lib/libutil/login_tty.3 b/lib/libutil/login_tty.3
index c9367b2..b19a551 100644
--- a/lib/libutil/login_tty.3
+++ b/lib/libutil/login_tty.3
@@ -23,7 +23,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $Id$
+.\" $Id: login_tty.3,v 1.1 1996/12/29 18:30:39 joerg Exp $
.\" "
.Dd December 29, 1996
.Os
@@ -43,11 +43,11 @@ on the
command line.
.Sh DESCRIPTION
The function
-.Nm login_tty
-prepares a terminal for a new login session. The filedescriptor
+.Fn login_tty
+prepares a terminal for a new login session. The file descriptor
.Ar fd
passed to
-.Nm login_tty
+.Fn login_tty
must be opened for reading and writing on a terminal device. It will be
made the controlling terminal for the calling process, after allocating
a new session with
@@ -55,7 +55,7 @@ a new session with
This terminal device will also be made the standard input, standard output,
and standard error output of the calling process.
.Sh RETURN VALUES
-.Nm Login_tty
+.Fn Login_tty
returns -1 if it could not make the device referenced by
.Ar fd
the controlling terminal of the calling process, and 0 otherwise.
diff --git a/lib/libutil/logout.3 b/lib/libutil/logout.3
index b4c768c..b3f093b 100644
--- a/lib/libutil/logout.3
+++ b/lib/libutil/logout.3
@@ -23,7 +23,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $Id$
+.\" $Id: logout.3,v 1.1 1996/12/29 18:30:40 joerg Exp $
.\" "
.Dd December 29, 1996
.Os
@@ -43,7 +43,7 @@ on the
command line.
.Sh DESCRIPTION
The function
-.Nm logout
+.Fn logout
searches the
.Xr utmp 5
file for the slot described by
@@ -53,9 +53,9 @@ with a record where the
.Em name
and
.Em host
-fields are empty, and the timestamp field is updated to the current time.
+fields are empty, and the time stamp field is updated to the current time.
.Sh RETURN VALUES
-.Nm Logout
+.Fn Logout
returns 1 if the slot described by
.Ar line
has been found and updated, 0 otherwise.
@@ -65,6 +65,6 @@ has been found and updated, 0 otherwise.
.Xr wtmp 5
.Sh BUGS
The calling interface of
-.Nm logout
-is incosistent with that of
+.Fn logout
+is inconsistent with that of
.Xr login 3 .
diff --git a/lib/libutil/logwtmp.3 b/lib/libutil/logwtmp.3
index 3a9a05c..faa9721 100644
--- a/lib/libutil/logwtmp.3
+++ b/lib/libutil/logwtmp.3
@@ -23,7 +23,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $Id$
+.\" $Id: logwtmp.3,v 1.1 1996/12/29 18:30:41 joerg Exp $
.\" "
.Dd December 29, 1996
.Os
@@ -43,7 +43,7 @@ on the
command line.
.Sh DESCRIPTION
The function
-.Nm logwtmp
+.Fn logwtmp
tries to append a new record to the
.Xr wtmp 5
file, using the provided arguments
diff --git a/lib/libutil/pty.3 b/lib/libutil/pty.3
index 4af344d..dbd634b 100644
--- a/lib/libutil/pty.3
+++ b/lib/libutil/pty.3
@@ -23,13 +23,14 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $Id$
+.\" $Id: pty.3,v 1.1 1996/12/29 18:30:42 joerg Exp $
.\" "
.Dd December 29, 1996
.Os
.Dt PTY 3
.Sh NAME
-.Nm openpty, forkpty
+.Nm openpty ,
+.Nm forkpty
.Nd auxiliary functions to obtain a pseudo-terminal
.Sh SYNOPSIS
.Fd #include <sys/types.h>
@@ -48,7 +49,7 @@ on the
command line.
.Sh DESCRIPTION
The function
-.Nm openpty
+.Fn openpty
attempts to obtain the next available pseudo-terminal from the system (see
.Xr pty 4 ) .
If it successfully found one, it subsequently tries to change the
@@ -64,7 +65,7 @@ If the argument
.Ar name
is not
.Dv NULL ,
-.Nm openpty
+.Fn openpty
copies the pathname of the slave pty to this area. The caller is
responsible to allocate the required space in this array.
.Pp
@@ -74,20 +75,20 @@ or
.Ar winp
are not
.Dv NULL ,
-.Nm openpty
+.Fn openpty
initializes the termios and window size settings from the structures
these argument point to, respectively.
.Pp
-Upon return, the open filedescriptors for the master and slave side
+Upon return, the open file descriptors for the master and slave side
of the pty are returned in the locations pointed to by
.Ar amaster
and
.Ar aslave ,
respectively.
.Pp
-.Nm Forkpty
+.Fn Forkpty
first calls
-.Xr openpty 3
+.Fn openpty
to obtain the next available pseudo-terminal from the system. Upon success,
it forks off a new process. In the child process, it closes the descriptor
for the master side of the pty, and calls
@@ -100,24 +101,24 @@ slave side of the pty. The arguments
and
.Ar winp
have the same meaning as described for
-.Nm openpty .
+.Fn openpty .
.Sh RETURN VALUES
-.Nm Openpty
+.Fn Openpty
returns 0 on success, or -1 on failure.
.Pp
-.Nm Forkpty
+.Fn Forkpty
returns -1 on failure, 0 in the slave process, and the process ID of the
slave process in the parent process.
.Sh ERRORS
On failure,
-.Nm openpty
+.Fn openpty
will set the global variable
.Dv errno
to
.Er ENOENT .
.Pp
In addition to this,
-.Nm forkpty
+.Fn forkpty
may set it to any value as described for
.Xr fork 2 .
.Sh SEE ALSO
@@ -134,10 +135,10 @@ may set it to any value as described for
.Sh BUGS
The calling process must have an effective UID of super-user in order
to perform all the intended actions. No notification will occur if
-.Nm openpty
+.Fn openpty
or
-.Nm forkpty
+.Fn forkpty
failed to proceed with one of the described steps, as long as they could
at least allocate the pty at all (and create the new process in the case
of
-.Nm forkpty ) .
+.Fn forkpty ) .
diff --git a/lib/libutil/setproctitle.3 b/lib/libutil/setproctitle.3
index 5e58dbd..3981a4f 100644
--- a/lib/libutil/setproctitle.3
+++ b/lib/libutil/setproctitle.3
@@ -17,7 +17,7 @@
.\" 5. Modifications may be freely made to this file providing the above
.\" conditions are met.
.\"
-.\" $Id: setproctitle.3,v 1.3 1996/01/30 18:13:11 mpp Exp $
+.\" $Id: setproctitle.3,v 1.4 1996/08/23 20:52:53 mpp Exp $
.\"
.\" The following requests are required for all man pages.
.Dd December 16, 1995
@@ -39,7 +39,7 @@ on the
command line.
.Sh DESCRIPTION
The
-.Nm setproctitle
+.Fn setproctitle
library routine sets the process title that appears on the
.Xr ps 1
command.
@@ -77,18 +77,18 @@ setproctitle("talking to %s", inet_ntoa(addr));
.Xr kvm_getargv 3 ,
.Xr printf 3
.Sh STANDARDS
-.Nm setproctitle
+.Fn setproctitle
is implicitly non-standard. Other methods of causing the
.Xr ps 1
command line to change, including copying over the argv[0] string are
also implicitly non-portable. It is preferable to use an operating system
supplied
-.Nm setproctitle
+.Fn setproctitle
if present.
.Pp
Unfortunately, it is possible that there are other calling conventions
to other versions of
-.Nm setproctitle ,
+.Fn setproctitle ,
although none have been found by the author as yet. This is believed to be
the predominant convention.
.Pp
@@ -98,7 +98,7 @@ including
and
.Tn BSD/OS .
.Sh HISTORY
-.Nm setproctitle
+.Fn setproctitle
first appeared in
.Fx 2.2 .
Other operating systems have
OpenPOWER on IntegriCloud