mirror of
https://git.FreeBSD.org/src.git
synced 2024-12-02 08:42:48 +00:00
Update a bunch of man pages to use .Fn instead
of .Nm when referencing funciton names.
This commit is contained in:
parent
0982f4916f
commit
bf5a138ec4
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=17780
@ -56,5 +56,5 @@ open(path, O_CREAT | O_TRUNC | O_WRONLY, mode);
|
||||
.Xr open 2
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn creat
|
||||
function call appeared in Version 6 AT&T UNIX.
|
||||
|
@ -90,6 +90,6 @@ of the sending process.
|
||||
.Xr sigaction 2
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn killpg
|
||||
function call appeared in
|
||||
.Bx 4.0 .
|
||||
|
@ -78,7 +78,7 @@ The previous set of masked signals is returned.
|
||||
.Xr sigsetops 3
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn sigblock
|
||||
function call appeared in
|
||||
.Bx 4.2
|
||||
and has been deprecated.
|
||||
|
@ -68,7 +68,7 @@ set to
|
||||
.Xr sigvec 2
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn sigpause
|
||||
function call appeared in
|
||||
.Bx 4.2
|
||||
and has been deprecated.
|
||||
|
@ -76,7 +76,7 @@ The previous set of masked signals is returned.
|
||||
.Xr sigsetops 3
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn sigsetmask
|
||||
function call appeared in
|
||||
.Bx 4.2
|
||||
and has been deprecated.
|
||||
|
@ -43,7 +43,8 @@
|
||||
.Fn confstr "int name" "char *buf" "size_t len"
|
||||
.Sh DESCRIPTION
|
||||
.Bf -symbolic
|
||||
This interface is obsoleted by sysctl(3).
|
||||
This interface is obsoleted by
|
||||
.Xr sysctl 3 .
|
||||
.Ef
|
||||
.Pp
|
||||
The
|
||||
@ -84,7 +85,7 @@ environment variable that finds all the standard utilities.
|
||||
.El
|
||||
.Sh RETURN VALUES
|
||||
If the call to
|
||||
.Nm confstr
|
||||
.Fn confstr
|
||||
is not successful, \-1 is returned and
|
||||
.Va errno
|
||||
is set appropriately.
|
||||
@ -101,7 +102,7 @@ the string in
|
||||
was truncated.
|
||||
.Sh ERRORS
|
||||
The
|
||||
.Nm confstr
|
||||
.Fn confstr
|
||||
function may fail and set
|
||||
.Va error
|
||||
for any of the errors specified for the library functions
|
||||
@ -119,5 +120,5 @@ argument is invalid.
|
||||
.Xr sysctl 3
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm confstr
|
||||
.Fn confstr
|
||||
function first appeared in 4.4BSD.
|
||||
|
@ -61,6 +61,6 @@ is returned.
|
||||
.Xr dev_mkdb 8
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm devname
|
||||
.Fn devname
|
||||
function call appeared in
|
||||
.Bx 4.4 .
|
||||
|
@ -30,7 +30,7 @@
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\" From: @(#)gethostname.3 8.1 (Berkeley) 6/4/93
|
||||
.\" $Id: getbootfile.3,v 1.1 1994/09/23 20:21:59 wollman Exp $
|
||||
.\" $Id: getbootfile.3,v 1.2 1996/02/11 22:33:31 mpp Exp $
|
||||
.\"
|
||||
.Dd September 23, 1994
|
||||
.Dt GETBOOTFILE 3
|
||||
@ -44,7 +44,7 @@
|
||||
.Fn getbootfile void
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm getbootfile
|
||||
.Fn getbootfile
|
||||
function retrieves the full pathname of the file from which the
|
||||
current kernel was loaded, and returns a static pointer to the name.
|
||||
A read/write interface to this information is available via the
|
||||
@ -65,7 +65,6 @@ the kernel at boot time, the static string
|
||||
is returned instead of the real boot file.
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn getbootfile
|
||||
function call appeared in
|
||||
.Tn FreeBSD
|
||||
2.0.
|
||||
.Fx 2.0 .
|
||||
|
@ -43,7 +43,7 @@
|
||||
.Fn getbsize "int *headerlenp" "long *blocksizep"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm getbsize
|
||||
.Fn getbsize
|
||||
function determines the user's preferred block size based on the value of the
|
||||
.Dq BLOCKSIZE
|
||||
environment variable; see
|
||||
@ -51,7 +51,7 @@ environment variable; see
|
||||
for details on its use and format.
|
||||
.Pp
|
||||
The
|
||||
.Nm getbsize
|
||||
.Fn getbsize
|
||||
function returns a pointer to a null-terminated string describing
|
||||
the block size, something like
|
||||
.Dq 1K-blocks .
|
||||
@ -74,6 +74,6 @@ a block size of 512 bytes.
|
||||
.Xr environ 7
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm getbsize
|
||||
.Fn getbsize
|
||||
function first appeared in
|
||||
.Bx 4.4 .
|
||||
|
@ -83,8 +83,9 @@ and returns a pointer to a
|
||||
.Xr malloc Ns \&'d
|
||||
copy of it in
|
||||
.Fa buf .
|
||||
.Nm Cgetent
|
||||
will first look for files ending in
|
||||
The
|
||||
.Fn cgetent
|
||||
function will first look for files ending in
|
||||
.Nm .db
|
||||
(see
|
||||
.Xr cap_mkdb 1)
|
||||
@ -111,13 +112,14 @@ and \-3 if a potential reference loop is detected (see
|
||||
.Ic tc=
|
||||
comments below).
|
||||
.Pp
|
||||
.Nm Cgetset
|
||||
enables the addition of a character buffer containing a single capability
|
||||
The
|
||||
.Fn cgetset
|
||||
function enables the addition of a character buffer containing a single capability
|
||||
record entry
|
||||
to the capability database.
|
||||
Conceptually, the entry is added as the first ``file'' in the database, and
|
||||
is therefore searched first on the call to
|
||||
.Nm cgetent .
|
||||
.Fn cgetent .
|
||||
The entry is passed in
|
||||
.Fa ent .
|
||||
If
|
||||
@ -125,29 +127,32 @@ If
|
||||
is
|
||||
.Dv NULL ,
|
||||
the current entry is removed from the database.
|
||||
.Nm Cgetset
|
||||
A call to
|
||||
.Fn cgetset
|
||||
must precede the database traversal. It must be called before the
|
||||
.Nm cgetent
|
||||
.Fn cgetent
|
||||
call. If a sequential access is being performed (see below), it must be called
|
||||
before the first sequential access call (
|
||||
.Nm cgetfirst
|
||||
.Fn cgetfirst
|
||||
or
|
||||
.Nm cgetnext
|
||||
.Fn cgetnext
|
||||
), or be directly preceded by a
|
||||
.Nm cgetclose
|
||||
.Fn cgetclose
|
||||
call.
|
||||
On success 0 is returned and \-1 on failure.
|
||||
.Pp
|
||||
.Nm Cgetmatch
|
||||
will return 0 if
|
||||
The
|
||||
.Fn cgetmatch
|
||||
function will return 0 if
|
||||
.Fa name
|
||||
is one of the names of the capability record
|
||||
.Fa buf ,
|
||||
\-1 if
|
||||
not.
|
||||
.Pp
|
||||
.Nm Cgetcap
|
||||
searches the capability record
|
||||
The
|
||||
.Fn cgetcap
|
||||
function searches the capability record
|
||||
.Fa buf
|
||||
for the capability
|
||||
.Fa cap
|
||||
@ -169,8 +174,9 @@ found. The end of the capability value is signaled by a `:' or
|
||||
.Dv NUL
|
||||
(see below for capability database syntax).
|
||||
.Pp
|
||||
.Nm Cgetnum
|
||||
retrieves the value of the numeric capability
|
||||
The
|
||||
.Fn cgetnum
|
||||
function retrieves the value of the numeric capability
|
||||
.Fa cap
|
||||
from the capability record pointed to by
|
||||
.Fa buf .
|
||||
@ -181,8 +187,9 @@ pointed to by
|
||||
0 is returned on success, \-1 if the requested numeric capability couldn't
|
||||
be found.
|
||||
.Pp
|
||||
.Nm Cgetstr
|
||||
retrieves the value of the string capability
|
||||
The
|
||||
.Fn cgetstr
|
||||
function retrieves the value of the string capability
|
||||
.Fa cap
|
||||
from the capability record pointed to by
|
||||
.Fa buf .
|
||||
@ -200,28 +207,33 @@ is returned on success, \-1 if the requested string capability couldn't
|
||||
be found, \-2 if a system error was encountered (storage allocation
|
||||
failure).
|
||||
.Pp
|
||||
.Nm Cgetustr
|
||||
is identical to
|
||||
.Nm cgetstr
|
||||
The
|
||||
.Fn cgetustr
|
||||
function is identical to
|
||||
.Fn cgetstr
|
||||
except that it does not expand special characters, but rather returns each
|
||||
character of the capability string literally.
|
||||
.Pp
|
||||
.Nm Cgetfirst ,
|
||||
.Nm cgetnext ,
|
||||
comprise a function group that provides for sequential
|
||||
The
|
||||
.Fn cgetfirst
|
||||
and
|
||||
.Fn cgetnext
|
||||
functions comprise a function group that provides for sequential
|
||||
access of the
|
||||
.Dv NULL
|
||||
pointer terminated array of file names,
|
||||
.Fa db_array .
|
||||
.Nm Cgetfirst
|
||||
returns the first record in the database and resets the access
|
||||
The
|
||||
.Fn cgetfirst
|
||||
function returns the first record in the database and resets the access
|
||||
to the first record.
|
||||
.Nm Cgetnext
|
||||
returns the next record in the database with respect to the
|
||||
The
|
||||
.Fn cgetnext
|
||||
function returns the next record in the database with respect to the
|
||||
record returned by the previous
|
||||
.Nm cgetfirst
|
||||
.Fn cgetfirst
|
||||
or
|
||||
.Nm cgetnext
|
||||
.Fn cgetnext
|
||||
call. If there is no such previous call, the first record in the database is
|
||||
returned.
|
||||
Each record is returned in a
|
||||
@ -242,10 +254,11 @@ is returned if a potential reference loop is detected (see
|
||||
comments below).
|
||||
Upon completion of database (0 return) the database is closed.
|
||||
.Pp
|
||||
.Nm Cgetclose
|
||||
closes the sequential access and frees any memory and file descriptors
|
||||
The
|
||||
.Fn cgetclose
|
||||
function closes the sequential access and frees any memory and file descriptors
|
||||
being used. Note that it does not erase the buffer pushed by a call to
|
||||
.Nm cgetset .
|
||||
.Fn cgetset .
|
||||
.Sh CAPABILITY DATABASE SYNTAX
|
||||
Capability databases are normally
|
||||
.Tn ASCII
|
||||
@ -301,16 +314,17 @@ Capability records describe a set of (name, value) bindings. Names may
|
||||
have multiple values bound to them. Different values for a name are
|
||||
distinguished by their
|
||||
.Fa types .
|
||||
.Nm Cgetcap
|
||||
will return a pointer to a value of a name given the capability name and
|
||||
the type of the value.
|
||||
The
|
||||
.Fn cgetcap
|
||||
function will return a pointer to a value of a name given the capability
|
||||
name and the type of the value.
|
||||
.Pp
|
||||
The types `#' and `=' are conventionally used to denote numeric and
|
||||
string typed values, but no restriction on those types is enforced. The
|
||||
functions
|
||||
.Nm cgetnum
|
||||
.Fn cgetnum
|
||||
and
|
||||
.Nm cgetstr
|
||||
.Fn cgetstr
|
||||
can be used to implement the traditional syntax and semantics of `#'
|
||||
and `='.
|
||||
Typeless capabilities are typically used to denote boolean objects with
|
||||
@ -380,7 +394,7 @@ file2:
|
||||
.Ed
|
||||
.Pp
|
||||
The records are extracted by calling
|
||||
.Nm cgetent
|
||||
.Fn cgetent
|
||||
with file1 preceding file2.
|
||||
In the capability record new in file1, fript=bar overrides the definition
|
||||
of fript=foo interpolated from the capability record old in file2,
|
||||
@ -392,9 +406,9 @@ tc=old is important here. If they were after, the definitions in old
|
||||
would take precedence.
|
||||
.Sh CGETNUM AND CGETSTR SYNTAX AND SEMANTICS
|
||||
Two types are predefined by
|
||||
.Nm cgetnum
|
||||
.Fn cgetnum
|
||||
and
|
||||
.Nm cgetstr :
|
||||
.Fn cgetstr :
|
||||
.Bl -column "nameXnumber"
|
||||
.Sm off
|
||||
.It Em name No \&# Em number Ta numeric
|
||||
@ -455,26 +469,28 @@ are typically used to denote the end of strings; many applications
|
||||
use `\e\|200' to represent a
|
||||
.Dv NUL .
|
||||
.Sh DIAGNOSTICS
|
||||
.Nm Cgetent ,
|
||||
.Nm cgetset ,
|
||||
.Nm cgetmatch ,
|
||||
.Nm cgetnum ,
|
||||
.Nm cgetstr ,
|
||||
.Nm cgetustr ,
|
||||
.Nm cgetfirst ,
|
||||
.Fn Cgetent ,
|
||||
.Fn cgetset ,
|
||||
.Fn cgetmatch ,
|
||||
.Fn cgetnum ,
|
||||
.Fn cgetstr ,
|
||||
.Fn cgetustr ,
|
||||
.Fn cgetfirst ,
|
||||
and
|
||||
.Nm cgetnext
|
||||
.Fn cgetnext
|
||||
return a value greater than or equal to 0 on success and a value less
|
||||
than 0 on failure.
|
||||
.Nm Cgetcap
|
||||
returns a character pointer on success and a
|
||||
The
|
||||
.Fn cgetcap
|
||||
function returns a character pointer on success and a
|
||||
.Dv NULL
|
||||
on failure.
|
||||
.Pp
|
||||
.Nm Cgetent ,
|
||||
The
|
||||
.Fn cgetent ,
|
||||
and
|
||||
.Nm cgetseq
|
||||
may fail and set
|
||||
.Fn cgetseq
|
||||
functions may fail and set
|
||||
.Va errno
|
||||
for any of the errors specified for the library functions:
|
||||
.Xr fopen 2 ,
|
||||
@ -483,11 +499,12 @@ for any of the errors specified for the library functions:
|
||||
and
|
||||
.Xr close 2 .
|
||||
.Pp
|
||||
.Nm Cgetent ,
|
||||
.Nm cgetset ,
|
||||
.Nm cgetstr ,
|
||||
The
|
||||
.Fn cgetent ,
|
||||
.Fn cgetset ,
|
||||
.Fn cgetstr ,
|
||||
and
|
||||
.Nm cgetustr
|
||||
.Fn cgetustr
|
||||
may fail and set
|
||||
.Va errno
|
||||
as follows:
|
||||
@ -504,8 +521,8 @@ Colons (`:') can't be used in names, types, or values.
|
||||
There are no checks for
|
||||
.Ic tc= name
|
||||
loops in
|
||||
.Nm cgetent .
|
||||
.Fn cgetent .
|
||||
.Pp
|
||||
The buffer added to the database by a call to
|
||||
.Nm cgetset
|
||||
.Fn cgetset
|
||||
is not unique to the database but is rather prepended to any database used.
|
||||
|
@ -30,7 +30,7 @@
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\" from: @(#)getdomainname.2 6.7 (Berkeley) 3/10/91
|
||||
.\" $Id: getdomainname.3,v 1.1 1994/12/18 14:06:39 guido Exp $
|
||||
.\" $Id: getdomainname.3,v 1.2 1996/02/11 22:33:32 mpp Exp $
|
||||
.\"
|
||||
.Dd March 10, 1991
|
||||
.Dt GETDOMAINNAME 3
|
||||
@ -93,6 +93,6 @@ Host names are limited to
|
||||
characters, currently 256.
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn getdomainname
|
||||
function call appeared in
|
||||
.Bx 4.2 .
|
||||
|
@ -92,6 +92,6 @@ Host names are limited to
|
||||
characters, currently 256.
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn gethostname
|
||||
function call appeared in
|
||||
.Bx 4.2 .
|
||||
|
@ -55,6 +55,6 @@ hardware page size.
|
||||
.Xr pagesize 1
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn getpagesze
|
||||
function call appeared in
|
||||
.Bx 4.2 .
|
||||
|
@ -48,7 +48,7 @@ The
|
||||
function displays a prompt to, and reads in a password from,
|
||||
.Pa /dev/tty .
|
||||
If this file is not accessible,
|
||||
.Nm getpass
|
||||
.Fn getpass
|
||||
displays the prompt on the standard error output and reads from the standard
|
||||
input.
|
||||
.Pp
|
||||
@ -57,12 +57,14 @@ characters in length.
|
||||
Any additional
|
||||
characters and the terminating newline character are discarded.
|
||||
.Pp
|
||||
.Nm Getpass
|
||||
turns off character echoing while reading the password.
|
||||
The
|
||||
.Fn getpass
|
||||
function turns off character echoing while reading the password.
|
||||
.Pp
|
||||
.Sh RETURN VALUES
|
||||
.Nm Getpass
|
||||
returns a pointer to the null terminated password.
|
||||
The
|
||||
.Fn getpass
|
||||
function returns a pointer to the null terminated password.
|
||||
.Sh FILES
|
||||
.Bl -tag -width /dev/tty -compact
|
||||
.It Pa /dev/tty
|
||||
@ -71,16 +73,16 @@ returns a pointer to the null terminated password.
|
||||
.Xr crypt 3
|
||||
.Sh HISTORY
|
||||
A
|
||||
.Nm getpass
|
||||
.Fn getpass
|
||||
function appeared in
|
||||
.At v7 .
|
||||
.Sh BUGS
|
||||
The
|
||||
.Nm getpass
|
||||
.Fn getpass
|
||||
function leaves its result in an internal static object and returns
|
||||
a pointer to that object.
|
||||
Subsequent calls to
|
||||
.Nm getpass
|
||||
.Fn getpass
|
||||
will modify the same object.
|
||||
.Pp
|
||||
The calling process should zero the password as soon as possible to
|
||||
|
@ -188,16 +188,16 @@ A Version 7 format password file
|
||||
.Xr vipw 8
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm getpwent ,
|
||||
.Nm getpwnam ,
|
||||
.Nm getpwuid ,
|
||||
.Nm setpwent,
|
||||
.Fn getpwent ,
|
||||
.Fn getpwnam ,
|
||||
.Fn getpwuid ,
|
||||
.Fn setpwent,
|
||||
and
|
||||
.Nm endpwent
|
||||
.Fn endpwent
|
||||
functions appeared in
|
||||
.At v7 .
|
||||
The
|
||||
.Nm setpassent
|
||||
.Fn setpassent
|
||||
function appeared in
|
||||
.Bx 4.3 Reno .
|
||||
.Sh COMPATIBILITY
|
||||
|
@ -67,14 +67,14 @@ returns \-1 if it was not invoked by the super-user.
|
||||
.Xr getgrouplist 3
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn initgorups
|
||||
function appeared in
|
||||
.Bx 4.2 .
|
||||
.Sh BUGS
|
||||
The
|
||||
.Fn getgrouplist
|
||||
function called by
|
||||
.Nm
|
||||
.Fn initgorups
|
||||
uses the routines based on
|
||||
.Xr getgrent 3 .
|
||||
If the invoking program uses any of these routines,
|
||||
|
@ -145,7 +145,7 @@ otherwise \-1.
|
||||
.El
|
||||
.Sh RETURN VALUES
|
||||
If the call to
|
||||
.Nm sysconf
|
||||
.Fn sysconf
|
||||
is not successful, \-1 is returned and
|
||||
.Va errno
|
||||
is set appropriately.
|
||||
@ -180,5 +180,5 @@ function conforms to
|
||||
.St -p1003.1-88 .
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm sysconf
|
||||
.Fn sysconf
|
||||
function first appeared in 4.4BSD.
|
||||
|
@ -44,11 +44,11 @@
|
||||
.Fn sysctl "int *name" "u_int namelen" "void *oldp" "size_t *oldlenp" "void *newp" "size_t newlen"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm sysctl
|
||||
.Fn sysctl
|
||||
function retrieves system information and allows processes with
|
||||
appropriate privileges to set system information.
|
||||
The information available from
|
||||
.Nm sysctl
|
||||
.Fn sysctl
|
||||
consists of integers, strings, and tables.
|
||||
Information may be retrieved and set from the command interface
|
||||
using the
|
||||
@ -56,12 +56,12 @@ using the
|
||||
utility.
|
||||
.Pp
|
||||
Unless explicitly noted below,
|
||||
.Nm sysctl
|
||||
.Fn sysctl
|
||||
returns a consistent snapshot of the data requested.
|
||||
Consistency is obtained by locking the destination
|
||||
buffer into memory so that the data may be copied out without blocking.
|
||||
Calls to
|
||||
.Nm sysctl
|
||||
.Fn sysctl
|
||||
are serialized to avoid deadlock.
|
||||
.Pp
|
||||
The state is described using a ``Management Information Base'' (MIB)
|
||||
@ -88,7 +88,7 @@ and
|
||||
should be set to NULL.
|
||||
.Pp
|
||||
The size of the available data can be determined by calling
|
||||
.Nm sysctl
|
||||
.Fn sysctl
|
||||
with a NULL parameter for
|
||||
.Fa oldp .
|
||||
The size of the available data will be returned in the location pointed to by
|
||||
@ -154,10 +154,10 @@ sysctl(mib, 2, p, &len, NULL, 0);
|
||||
.Sh CTL_DEBUG
|
||||
The debugging variables vary from system to system.
|
||||
A debugging variable may be added or deleted without need to recompile
|
||||
.Nm sysctl
|
||||
.Fn sysctl
|
||||
to know about it.
|
||||
Each time it runs,
|
||||
.Nm sysctl
|
||||
.Fn sysctl
|
||||
gets the list of debugging variables from the kernel and
|
||||
displays their current values.
|
||||
The system defines twenty
|
||||
@ -583,7 +583,7 @@ The returned data consists of a
|
||||
.El
|
||||
.Sh RETURN VALUES
|
||||
If the call to
|
||||
.Nm sysctl
|
||||
.Fn sysctl
|
||||
is successful, 0 is returned.
|
||||
Otherwise \-1 is returned and
|
||||
.Va errno
|
||||
@ -649,5 +649,5 @@ definitions for fourth level UDP identifiers
|
||||
.Xr sysctl 8
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm sysctl
|
||||
.Fn sysctl
|
||||
function first appeared in 4.4BSD.
|
||||
|
@ -44,15 +44,15 @@
|
||||
.Fn tcgetpgrp "int fd"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm tcgetpgrp
|
||||
.Fn tcgetpgrp
|
||||
function returns the value of the process group ID of the foreground
|
||||
process group associated with the terminal device.
|
||||
If there is no foreground process group,
|
||||
.Nm tcgetpgrp
|
||||
.Fn tcgetpgrp
|
||||
returns an invalid process ID.
|
||||
.Sh ERRORS
|
||||
If an error occurs,
|
||||
.Nm tcgetpgrp
|
||||
.Fn tcgetpgrp
|
||||
returns -1 and the global variable
|
||||
.Va errno
|
||||
is set to indicate the error, as follows:
|
||||
@ -73,7 +73,7 @@ is not the controlling terminal.
|
||||
.Xr tcsetpgrp 3
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nm tcgetpgrp
|
||||
.Fn tcgetpgrp
|
||||
function is expected to be compliant with the
|
||||
.St -p1003.1-88
|
||||
specification.
|
||||
|
@ -52,13 +52,13 @@
|
||||
.Fn tcsendbreak "int fd" "int len"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm tcdrain
|
||||
.Fn tcdrain
|
||||
function waits until all output written to the terminal referenced by
|
||||
.Fa fd
|
||||
has been transmitted to the terminal.
|
||||
.Pp
|
||||
The
|
||||
.Nm tcflow
|
||||
.Fn tcflow
|
||||
function suspends transmission of data to or the reception of data from
|
||||
the terminal referenced by
|
||||
.Fa fd
|
||||
@ -89,7 +89,7 @@ section of
|
||||
.El
|
||||
.Pp
|
||||
The
|
||||
.Nm tcflush
|
||||
.Fn tcflush
|
||||
function discards any data written to the terminal referenced by
|
||||
.Fa fd
|
||||
which has not been transmitted to the terminal, or any data received
|
||||
@ -108,7 +108,7 @@ Flush both data received but not read and data written but not transmitted.
|
||||
.El
|
||||
.Pp
|
||||
The
|
||||
.Nm tcsendbreak
|
||||
.Fn tcsendbreak
|
||||
function transmits a continuous stream of zero-valued bits for four-tenths
|
||||
of a second to the terminal referenced by
|
||||
.Fa fd .
|
||||
@ -136,7 +136,7 @@ The file associated with
|
||||
is not a terminal.
|
||||
.It Bq Er EINTR
|
||||
A signal interrupted the
|
||||
.Nm tcdrain
|
||||
.Fn tcdrain
|
||||
function.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
@ -144,11 +144,11 @@ function.
|
||||
.Xr termios 4
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nm tcsendbreak ,
|
||||
.Nm tcdrain ,
|
||||
.Nm tcflush
|
||||
.Fn tcsendbreak ,
|
||||
.Fn tcdrain ,
|
||||
.Fn tcflush
|
||||
and
|
||||
.Nm tcflow
|
||||
.Fn tcflow
|
||||
functions are expected to be compliant with the
|
||||
.St -p1003.1-88
|
||||
specification.
|
||||
|
@ -64,30 +64,30 @@
|
||||
.Fn tcsetattr "int fd" "int action" "struct termios *t"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm cfmakeraw ,
|
||||
.Nm tcgetattr
|
||||
.Fn cfmakeraw ,
|
||||
.Fn tcgetattr
|
||||
and
|
||||
.Nm tcsetattr
|
||||
.Fn tcsetattr
|
||||
functions are provided for getting and setting the termios structure.
|
||||
.Pp
|
||||
The
|
||||
.Nm cfgetispeed ,
|
||||
.Nm cfsetispeed ,
|
||||
.Nm cfgetospeed ,
|
||||
.Nm cfsetospeed
|
||||
.Fn cfgetispeed ,
|
||||
.Fn cfsetispeed ,
|
||||
.Fn cfgetospeed ,
|
||||
.Fn cfsetospeed
|
||||
and
|
||||
.Nm cfsetspeed
|
||||
.Fn cfsetspeed
|
||||
functions are provided for getting and setting the baud rate values in
|
||||
the termios structure.
|
||||
The effects of the functions on the terminal as described below
|
||||
do not become effective, nor are all errors detected, until the
|
||||
.Nm tcsetattr
|
||||
.Fn tcsetattr
|
||||
function is called.
|
||||
Certain values for baud rates set in the termios structure and passed to
|
||||
.Nm tcsetattr
|
||||
.Fn tcsetattr
|
||||
have special meanings.
|
||||
These are discussed in the portion of the manual page that describes the
|
||||
.Nm tcsetattr
|
||||
.Fn tcsetattr
|
||||
function.
|
||||
.Sh GETTING AND SETTING THE BAUD RATE
|
||||
The input and output baud rates are found in the termios structure.
|
||||
@ -121,31 +121,31 @@ represented, however, the following symbolic values are defined.
|
||||
.Ed
|
||||
.Pp
|
||||
The
|
||||
.Nm cfgetispeed
|
||||
.Fn cfgetispeed
|
||||
function returns the input baud rate in the termios structure referenced by
|
||||
.Fa tp .
|
||||
.Pp
|
||||
The
|
||||
.Nm cfsetispeed
|
||||
.Fn cfsetispeed
|
||||
function sets the input baud rate in the termios structure referenced by
|
||||
.Fa tp
|
||||
to
|
||||
.Fa speed .
|
||||
.Pp
|
||||
The
|
||||
.Nm cfgetospeed
|
||||
.Fn cfgetospeed
|
||||
function returns the output baud rate in the termios structure referenced by
|
||||
.Fa tp .
|
||||
.Pp
|
||||
The
|
||||
.Nm cfsetospeed
|
||||
.Fn cfsetospeed
|
||||
function sets the output baud rate in the termios structure referenced by
|
||||
.Fa tp
|
||||
to
|
||||
.Fa speed .
|
||||
.Pp
|
||||
The
|
||||
.Nm cfsetspeed
|
||||
.Fn cfsetspeed
|
||||
function sets both the input and output baud rate in the termios structure
|
||||
referenced by
|
||||
.Fa tp
|
||||
@ -153,10 +153,10 @@ to
|
||||
.Fa speed .
|
||||
.Pp
|
||||
Upon successful completion, the functions
|
||||
.Nm cfsetispeed ,
|
||||
.Nm cfsetospeed ,
|
||||
.Fn cfsetispeed ,
|
||||
.Fn cfsetospeed ,
|
||||
and
|
||||
.Nm cfsetspeed
|
||||
.Fn cfsetspeed
|
||||
return a value of 0.
|
||||
Otherwise, a value of -1 is returned and the global variable
|
||||
.Va errno
|
||||
@ -178,7 +178,7 @@ file, not just the open file description associated with the particular
|
||||
file descriptor.
|
||||
.Pp
|
||||
The
|
||||
.Nm cfmakeraw
|
||||
.Fn cfmakeraw
|
||||
function sets the flags stored in the termios structure to a state disabling
|
||||
all input and output processing, giving a
|
||||
.Dq raw I/O path.
|
||||
@ -186,17 +186,17 @@ It should be noted that there is no function to reverse this effect.
|
||||
This is because there are a variety of processing options that could be
|
||||
re-enabled and the correct method is for an application to snapshot the
|
||||
current terminal state using the function
|
||||
.Nm tcgetattr ,
|
||||
.Fn tcgetattr ,
|
||||
setting raw mode with
|
||||
.Nm cfmakeraw
|
||||
.Fn cfmakeraw
|
||||
and the subsequent
|
||||
.Nm tcsetattr ,
|
||||
.Fn tcsetattr ,
|
||||
and then using another
|
||||
.Nm tcsetattr
|
||||
.Fn tcsetattr
|
||||
with the saved state to revert to the previous terminal state.
|
||||
.Pp
|
||||
The
|
||||
.Nm tcgetattr
|
||||
.Fn tcgetattr
|
||||
function copies the parameters associated with the terminal referenced
|
||||
by
|
||||
.Fa fd
|
||||
@ -206,7 +206,7 @@ This function is allowed from a background process, however, the terminal
|
||||
attributes may be subsequently changed by a foreground process.
|
||||
.Pp
|
||||
The
|
||||
.Nm tcsetattr
|
||||
.Fn tcsetattr
|
||||
function sets the parameters associated with the terminal from the
|
||||
termios structure referenced by
|
||||
.Fa tp .
|
||||
@ -246,17 +246,17 @@ fields are ignored.
|
||||
.Pp
|
||||
The 0 baud rate is used to terminate the connection.
|
||||
If 0 is specified as the output speed to the function
|
||||
.Nm tcsetattr ,
|
||||
.Fn tcsetattr ,
|
||||
modem control will no longer be asserted on the terminal, disconnecting
|
||||
the terminal.
|
||||
.Pp
|
||||
If zero is specified as the input speed to the function
|
||||
.Nm tcsetattr ,
|
||||
.Fn tcsetattr ,
|
||||
the input baud rate will be set to the same value as that specified by
|
||||
the output baud rate.
|
||||
.Pp
|
||||
If
|
||||
.Nm tcsetattr
|
||||
.Fn tcsetattr
|
||||
is unable to make any of the requested changes, it returns -1 and
|
||||
sets errno.
|
||||
Otherwise, it makes all of the requested changes it can.
|
||||
@ -264,9 +264,9 @@ If the specified input and output baud rates differ and are a combination
|
||||
that is not supported, neither baud rate is changed.
|
||||
.Pp
|
||||
Upon successful completion, the functions
|
||||
.Nm tcgetattr
|
||||
.Fn tcgetattr
|
||||
and
|
||||
.Nm tcsetattr
|
||||
.Fn tcsetattr
|
||||
return a value of 0.
|
||||
Otherwise, they
|
||||
return -1 and the global variable
|
||||
@ -277,28 +277,28 @@ is set to indicate the error, as follows:
|
||||
The
|
||||
.Fa fd
|
||||
argument to
|
||||
.Nm tcgetattr
|
||||
.Fn tcgetattr
|
||||
or
|
||||
.Nm tcsetattr
|
||||
.Fn tcsetattr
|
||||
was not a valid file descriptor.
|
||||
.It Bq Er EINTR
|
||||
The
|
||||
.Nm tcsetattr
|
||||
.Fn tcsetattr
|
||||
function was interrupted by a signal.
|
||||
.It Bq Er EINVAL
|
||||
The
|
||||
.Fa action
|
||||
argument to the
|
||||
.Nm tcsetattr
|
||||
.Fn tcsetattr
|
||||
function was not valid, or an attempt was made to change an attribute
|
||||
represented in the termios structure to an unsupported value.
|
||||
.It Bq Er ENOTTY
|
||||
The file associated with the
|
||||
.Fa fd
|
||||
argument to
|
||||
.Nm tcgetattr
|
||||
.Fn tcgetattr
|
||||
or
|
||||
.Nm tcsetattr
|
||||
.Fn tcsetattr
|
||||
is not a terminal.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
@ -306,25 +306,25 @@ is not a terminal.
|
||||
.Xr termios 4
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nm cfgetispeed ,
|
||||
.Nm cfsetispeed ,
|
||||
.Nm cfgetospeed ,
|
||||
.Nm cfsetospeed ,
|
||||
.Nm tcgetattr
|
||||
.Fn cfgetispeed ,
|
||||
.Fn cfsetispeed ,
|
||||
.Fn cfgetospeed ,
|
||||
.Fn cfsetospeed ,
|
||||
.Fn tcgetattr
|
||||
and
|
||||
.Nm tcsetattr
|
||||
.Fn tcsetattr
|
||||
functions are expected to be compliant with the
|
||||
.St -p1003.1-88
|
||||
specification.
|
||||
The
|
||||
.Nm cfmakeraw
|
||||
.Fn cfmakeraw
|
||||
and
|
||||
.Nm cfsetspeed
|
||||
.Fn cfsetspeed
|
||||
functions,
|
||||
as well as the
|
||||
.Li TCSASOFT
|
||||
option to the
|
||||
.Nm tcsetattr
|
||||
.Fn tcsetattr
|
||||
function are extensions to the
|
||||
.St -p1003.1-88
|
||||
specification.
|
||||
|
@ -318,7 +318,7 @@ leap seconds are loaded from
|
||||
.Xr tzfile 5
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm tzset
|
||||
.Fn tzset
|
||||
and
|
||||
.Nm tzsetwall
|
||||
.Fn tzsetwall
|
||||
functions first appeared in 4.4BSD.
|
||||
|
@ -67,7 +67,7 @@ Machine hardware platform.
|
||||
.El
|
||||
.Sh RETURN VALUES
|
||||
If
|
||||
.Nm uname
|
||||
.Fn uname
|
||||
is successful, 0 is returned, otherwise, -1 is returned and
|
||||
.Va errno
|
||||
is set appropriately.
|
||||
@ -88,5 +88,5 @@ function conforms to
|
||||
.St -p1003.1-88 .
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm uname
|
||||
.Fn uname
|
||||
function first appeared in 4.4BSD.
|
||||
|
@ -82,6 +82,6 @@ function appeared in
|
||||
.At v7 .
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nm utime
|
||||
.Fn utime
|
||||
function conforms to
|
||||
.St -p1003.1-88 .
|
||||
|
@ -56,7 +56,7 @@ is being caught and the signal handler does not return.
|
||||
No open streams are closed or flushed.
|
||||
.Sh RETURN VALUES
|
||||
The
|
||||
.Nm abort
|
||||
.Fn abort
|
||||
function
|
||||
never returns.
|
||||
.Sh SEE ALSO
|
||||
|
@ -107,6 +107,6 @@ can never return.
|
||||
.Xr exit 3
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nm _exit
|
||||
.Fn _exit
|
||||
function is defined by
|
||||
.St -p1003.1-88 .
|
||||
|
@ -186,6 +186,6 @@ are present to be accepted.
|
||||
.Xr socket 2
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn accept
|
||||
function appeared in
|
||||
.Bx 4.2 .
|
||||
|
@ -111,5 +111,5 @@ An I/O error occurred while reading from or writing to the file system.
|
||||
.Xr sa 8
|
||||
.Sh HISTORY
|
||||
An
|
||||
.Nm
|
||||
.Fn acct
|
||||
function call appeared in Version 7 AT&T UNIX.
|
||||
|
@ -106,6 +106,6 @@ The process's effective user ID is not that of the super-user.
|
||||
.Re
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn adjtime
|
||||
function call appeared in
|
||||
.Bx 4.3 .
|
||||
|
@ -143,6 +143,6 @@ An empty pathname was specified.
|
||||
.Xr getsockname 2
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn bind
|
||||
function call appeared in
|
||||
.Bx 4.2 .
|
||||
|
@ -102,13 +102,13 @@ e.g.
|
||||
for the definition of
|
||||
.Em etext ) .
|
||||
.Sh RETURN VALUES
|
||||
.Nm Brk
|
||||
.Fn Brk
|
||||
returns 0 if successful;
|
||||
otherwise -1 with
|
||||
.Va errno
|
||||
set to indicate why the allocation failed.
|
||||
The
|
||||
.Nm sbrk
|
||||
.Fn sbrk
|
||||
function returns a pointer to the base of the new storage if successful;
|
||||
otherwise -1 with
|
||||
.Va errno
|
||||
@ -142,5 +142,5 @@ the data segment without consulting
|
||||
.Xr getrlimit 2 .
|
||||
.Sh HISTORY
|
||||
A
|
||||
.Nm
|
||||
.Fn brk
|
||||
function call appeared in Version 7 AT&T UNIX.
|
||||
|
@ -94,6 +94,6 @@ An I/O error occurred while reading from or writing to the file system.
|
||||
.Xr chdir 2
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn chroot
|
||||
function call appeared in
|
||||
.Bx 4.2 .
|
||||
|
@ -166,6 +166,6 @@ Too many symbolic links were encountered in translating the pathname.
|
||||
.Xr getsockname 2
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn connect
|
||||
function call appeared in
|
||||
.Bx 4.2 .
|
||||
|
@ -274,6 +274,6 @@ of a super-user as well.
|
||||
.Xr environ 7
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn execve
|
||||
function call appeared in
|
||||
.Bx 4.2 .
|
||||
|
@ -170,7 +170,7 @@ taken as a pointer to a
|
||||
.Fa "struct flock"
|
||||
(see above).
|
||||
The information retrieved overwrites the information passed to
|
||||
.Nm fcntl
|
||||
.Fn fcntl
|
||||
in the
|
||||
.Fa flock
|
||||
structure.
|
||||
@ -193,7 +193,7 @@ or exclusive (or write) locks,
|
||||
as well as remove either type of lock
|
||||
.Dv (F_UNLCK) .
|
||||
If a shared or exclusive lock cannot be set,
|
||||
.Nm fcntl
|
||||
.Fn fcntl
|
||||
returns immediately with
|
||||
.Er EACCES .
|
||||
.It Dv F_SETLKW
|
||||
@ -202,9 +202,9 @@ This command is the same as
|
||||
except that if a shared or exclusive lock is blocked by other locks,
|
||||
the process waits until the request can be satisfied.
|
||||
If a signal that is to be caught is received while
|
||||
.Nm fcntl
|
||||
.Fn fcntl
|
||||
is waiting for a region, the
|
||||
.Nm fcntl
|
||||
.Fn fcntl
|
||||
will be interrupted if the signal handler has not specified the
|
||||
.Dv SA_RESTART
|
||||
(see
|
||||
@ -511,6 +511,6 @@ for the reasons as stated in
|
||||
.Xr tcsetpgrp 3
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn fcntl
|
||||
function call appeared in
|
||||
.Bx 4.2 .
|
||||
|
@ -162,6 +162,6 @@ refers to an object other than a file.
|
||||
.Xr fork 2
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
.Fn flock
|
||||
function call appeared in
|
||||
.Bx 4.2 .
|
||||
|
Loading…
Reference in New Issue
Block a user