Consistently mark std(in|out|err) with .Dv, because that's how they
are marked up in stdio(3), and because they are defined expressions of type "FILE *". Approved by: re
This commit is contained in:
parent
a597332c22
commit
ae82896268
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=107619
@ -45,7 +45,7 @@ The
|
||||
.Fn fmtmsg
|
||||
function displays a detailed diagnostic message, based on
|
||||
the supplied arguments, to
|
||||
.Em stderr
|
||||
.Dv stderr
|
||||
and/or the system console.
|
||||
.Pp
|
||||
The
|
||||
@ -64,7 +64,7 @@ may be specified.
|
||||
.Bl -tag -width ".Dv MM_CONSOLE"
|
||||
.It Dv MM_PRINT
|
||||
Output should take place on
|
||||
.Em stderr .
|
||||
.Dv stderr .
|
||||
.It Dv MM_CONSOLE
|
||||
Output should take place on the system console.
|
||||
.El
|
||||
@ -169,13 +169,13 @@ function returns
|
||||
upon success,
|
||||
.Dv MM_NOMSG
|
||||
to indicate output to
|
||||
.Em stderr
|
||||
.Dv stderr
|
||||
failed,
|
||||
.Dv MM_NOCON
|
||||
to indicate output to the system console failed, or
|
||||
.Dv MM_NOTOK
|
||||
to indicate output to
|
||||
.Em stderr
|
||||
.Dv stderr
|
||||
and the system console failed.
|
||||
.Sh ENVIRONMENT
|
||||
The
|
||||
@ -184,7 +184,7 @@ The
|
||||
environment variable specifies which arguments to
|
||||
.Fn fmtmsg
|
||||
will be output to
|
||||
.Em stderr ,
|
||||
.Dv stderr ,
|
||||
and in which order.
|
||||
.Ev MSGVERB
|
||||
should be a colon
|
||||
@ -214,7 +214,7 @@ TO FIX: refer to manual BSD:ls:001
|
||||
.Ed
|
||||
.Pp
|
||||
to
|
||||
.Em stderr .
|
||||
.Dv stderr .
|
||||
.Pp
|
||||
The same code, with
|
||||
.Ev MSGVERB
|
||||
|
@ -105,9 +105,9 @@ a socket in the Internet domain of type
|
||||
.Dv SOCK_STREAM
|
||||
is returned to the caller, and given to the remote
|
||||
command as
|
||||
.Em stdin
|
||||
.Dv stdin
|
||||
and
|
||||
.Em stdout .
|
||||
.Dv stdout .
|
||||
If
|
||||
.Fa fd2p
|
||||
is non-zero, then an auxiliary channel to a control
|
||||
@ -123,10 +123,10 @@ forwarded to the process group of the command.
|
||||
If
|
||||
.Fa fd2p
|
||||
is 0, then the
|
||||
.Em stderr
|
||||
.Dv stderr
|
||||
(unit 2 of the remote
|
||||
command) will be made the same as the
|
||||
.Em stdout
|
||||
.Dv stdout
|
||||
and no
|
||||
provision is made for sending arbitrary signals to the remote process,
|
||||
although you may be able to get its attention by using out-of-band data.
|
||||
|
@ -90,7 +90,10 @@ a socket in the
|
||||
domain of type
|
||||
.Dv SOCK_STREAM
|
||||
is returned to the caller, and given to the remote
|
||||
command as stdin, stdout, and stderr.
|
||||
command as
|
||||
.Dv stdin , stdout ,
|
||||
and
|
||||
.Dv stderr .
|
||||
.Sh RETURN VALUES
|
||||
The
|
||||
.Fn rcmdsh
|
||||
|
@ -78,7 +78,7 @@ with an infinite
|
||||
and a
|
||||
.Fa stream
|
||||
of
|
||||
.Em stdin ,
|
||||
.Dv stdin ,
|
||||
except that the newline character (if any) is not stored in the string.
|
||||
It is the caller's responsibility to ensure that the input line,
|
||||
if any, is sufficiently short to fit in the string.
|
||||
|
@ -164,10 +164,9 @@ The primary use of the
|
||||
function
|
||||
is to change the file associated with a
|
||||
standard text stream
|
||||
.Pf ( Em stderr ,
|
||||
.Em stdin ,
|
||||
.Dv ( stderr , stdin ,
|
||||
or
|
||||
.Em stdout ) .
|
||||
.Dv stdout ) .
|
||||
.Sh RETURN VALUES
|
||||
Upon successful completion
|
||||
.Fn fopen ,
|
||||
|
@ -68,7 +68,7 @@ writes the string
|
||||
.Fa str ,
|
||||
and a terminating newline character,
|
||||
to the stream
|
||||
.Em stdout .
|
||||
.Dv stdout .
|
||||
.Sh RETURN VALUES
|
||||
The
|
||||
.Fn fputs
|
||||
|
@ -78,7 +78,7 @@ function
|
||||
is equivalent to
|
||||
.Fn getwc
|
||||
with the argument
|
||||
.Em stdin .
|
||||
.Dv stdin .
|
||||
.Sh RETURN VALUES
|
||||
If successful, these routines return the next wide-character
|
||||
from the
|
||||
|
@ -78,7 +78,7 @@ as described below.
|
||||
and
|
||||
.Fn vprintf
|
||||
write output to
|
||||
.Pa stdout ,
|
||||
.Dv stdout ,
|
||||
the standard output stream;
|
||||
.Fn fprintf
|
||||
and
|
||||
|
@ -84,7 +84,7 @@ macro
|
||||
is identical to
|
||||
.Fn putc
|
||||
with an output stream of
|
||||
.Em stdout .
|
||||
.Dv stdout .
|
||||
.Pp
|
||||
The
|
||||
.Fn putw
|
||||
|
@ -78,7 +78,7 @@ function
|
||||
is identical to
|
||||
.Fn putwc
|
||||
with an output stream of
|
||||
.Em stdout .
|
||||
.Dv stdout .
|
||||
.Sh RETURN VALUES
|
||||
The
|
||||
.Fn fputwc ,
|
||||
|
@ -80,7 +80,7 @@ The
|
||||
.Fn scanf
|
||||
function
|
||||
reads input from the standard input stream
|
||||
.Em stdin ,
|
||||
.Dv stdin ,
|
||||
.Fn fscanf
|
||||
reads input from the stream pointer
|
||||
.Fa stream ,
|
||||
|
@ -65,7 +65,8 @@ destination file or terminal as soon as written;
|
||||
when it is block buffered many characters are saved up and written as a block;
|
||||
when it is line buffered characters are saved up until a newline is
|
||||
output or input is read from any stream attached to a terminal device
|
||||
(typically stdin).
|
||||
(typically
|
||||
.Dv stdin ) .
|
||||
The function
|
||||
.Xr fflush 3
|
||||
may be used to force the block out early.
|
||||
@ -81,10 +82,10 @@ is called,
|
||||
and an optimally-sized buffer is obtained.
|
||||
If a stream refers to a terminal
|
||||
(as
|
||||
.Em stdout
|
||||
.Dv stdout
|
||||
normally does) it is line buffered.
|
||||
The standard error stream
|
||||
.Em stderr
|
||||
.Dv stderr
|
||||
is always unbuffered.
|
||||
.Pp
|
||||
The
|
||||
|
@ -127,9 +127,9 @@ opened explicitly:
|
||||
(for writing diagnostic output).
|
||||
.El
|
||||
These streams are abbreviated
|
||||
.Em stdin , stdout
|
||||
.Dv stdin , stdout
|
||||
and
|
||||
.Em stderr .
|
||||
.Dv stderr .
|
||||
Initially, the standard error stream
|
||||
is unbuffered; the standard input and output streams are
|
||||
fully buffered if and only if the streams do not refer to
|
||||
|
@ -74,7 +74,7 @@ and
|
||||
.Fn vwprintf
|
||||
functions
|
||||
write output to
|
||||
.Pa stdout ,
|
||||
.Dv stdout ,
|
||||
the standard output stream;
|
||||
.Fn fwprintf
|
||||
and
|
||||
|
@ -82,7 +82,7 @@ The
|
||||
.Fn wscanf
|
||||
function
|
||||
reads input from the standard input stream
|
||||
.Em stdin ,
|
||||
.Dv stdin ,
|
||||
.Fn fwscanf
|
||||
reads input from the stream pointer
|
||||
.Fa stream ,
|
||||
|
@ -145,7 +145,7 @@ function encounters a character not found in the string
|
||||
.Va optstring
|
||||
or detects
|
||||
a missing option argument it writes an error message to the
|
||||
.Em stderr
|
||||
.Dv stderr
|
||||
and returns
|
||||
.Ql ?\& .
|
||||
Setting
|
||||
|
@ -223,7 +223,9 @@ This option is incompatible with the
|
||||
option.
|
||||
.It X
|
||||
Rather than return failure for any allocation function,
|
||||
display a diagnostic message on stderr and cause the program to drop
|
||||
display a diagnostic message on
|
||||
.Dv stderr
|
||||
and cause the program to drop
|
||||
core (using
|
||||
.Xr abort 3 ) .
|
||||
This option should be set at compile time by including the following in
|
||||
@ -390,7 +392,9 @@ The
|
||||
.Va _malloc_message
|
||||
variable allows the programmer to override the function which emits
|
||||
the text strings forming the errors and warnings if for some reason
|
||||
the stderr filedescriptor is not suitable for this.
|
||||
the
|
||||
.Dv stderr
|
||||
file descriptor is not suitable for this.
|
||||
Please note that doing anything which tries to allocate memory in
|
||||
this function will assure death of the process.
|
||||
.Pp
|
||||
|
@ -87,9 +87,9 @@ a socket in the Internet domain of type
|
||||
.Dv SOCK_STREAM
|
||||
is returned to
|
||||
the caller, and given to the remote command as
|
||||
.Em stdin
|
||||
.Dv stdin
|
||||
and
|
||||
.Em stdout .
|
||||
.Dv stdout .
|
||||
If
|
||||
.Fa fd2p
|
||||
is non-zero, then an auxiliary channel to a control
|
||||
@ -108,10 +108,10 @@ verified.
|
||||
If
|
||||
.Fa fd2p
|
||||
is 0, then the
|
||||
.Em stderr
|
||||
.Dv stderr
|
||||
(unit 2 of the remote
|
||||
command) will be made the same as the
|
||||
.Em stdout
|
||||
.Dv stdout
|
||||
and no
|
||||
provision is made for sending arbitrary signals to the remote process,
|
||||
although you may be able to get its attention by using out-of-band data.
|
||||
|
@ -214,7 +214,8 @@ or
|
||||
.Fn Clone_Disk .
|
||||
.Pp
|
||||
.Fn Debug_Disk
|
||||
prints the content of the tree to stdout.
|
||||
prints the content of the tree to
|
||||
.Dv stdout .
|
||||
.Pp
|
||||
.Fn Set_Bios_Geom
|
||||
sets the geometry the bios uses.
|
||||
|
@ -83,7 +83,9 @@ issue since any code that manipulates processes is inherently
|
||||
machine dependent.
|
||||
.Pp
|
||||
Finally, the Sun kvm error reporting semantics are poorly defined.
|
||||
The library can be configured either to print errors to stderr automatically,
|
||||
The library can be configured either to print errors to
|
||||
.Dv stderr
|
||||
automatically,
|
||||
or to print no error messages at all.
|
||||
In the latter case, the nature of the error cannot be determined.
|
||||
To overcome this, the
|
||||
|
@ -118,7 +118,9 @@ no errors are reported and the application cannot know the
|
||||
specific nature of the failed kvm call.
|
||||
If it is not
|
||||
.Dv NULL ,
|
||||
errors are printed to stderr with
|
||||
errors are printed to
|
||||
.Dv stderr
|
||||
with
|
||||
.Fa errstr
|
||||
prepended to the message, as in
|
||||
.Xr perror 3 .
|
||||
|
@ -50,7 +50,7 @@ and if it is false,
|
||||
the calling process is terminated.
|
||||
A
|
||||
diagnostic message is written to
|
||||
.Em stderr
|
||||
.Dv stderr
|
||||
and the function
|
||||
.Xr abort 3
|
||||
is called, effectively terminating the program.
|
||||
|
Loading…
Reference in New Issue
Block a user