BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.bin / printf / printf.1

diff --git a/usr/src/usr.bin/printf/printf.1 b/usr/src/usr.bin/printf/printf.1
index f0899b8..34f0668 100644 (file)
--- a/usr/src/usr.bin/printf/printf.1
+++ b/usr/src/usr.bin/printf/printf.1
@@ -1,32 +1,48 @@
 .\" Copyright (c) 1989, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1989, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" This code is derived from software contributed to Berkeley by
+.\" the Institute of Electrical and Electronics Engineers, Inc.

 .\"
 .\"

-.\"     @(#)printf.1   5.8 (Berkeley) 7/24/90
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.Dd July 24, 1990
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"    @(#)printf.1    5.11 (Berkeley) 7/24/91
+.\"
+.Dd July 24, 1991

 .Dt PRINTF 1
 .Dt PRINTF 1

-.AT 1
+.Os

 .Sh NAME
 .Nm printf
 .Nd formatted output
 .Sh SYNOPSIS
 .Sh NAME
 .Nm printf
 .Nd formatted output
 .Sh SYNOPSIS

-.Pp

 .Nm printf format
 .Nm printf format

-.Op  arguments  ...
+.Op arguments  ...

 .Sh DESCRIPTION
 .Nm Printf
 formats and prints its arguments, after the first, under control
 .Sh DESCRIPTION
 .Nm Printf
 formats and prints its arguments, after the first, under control


@@ -46,15 +62,16 @@ after the first are treated as strings if the corresponding format is
 either
 .Cm c
 or
 either
 .Cm c
 or

-.Cm s  ;
+.Cm s ;

 otherwise it is evaluated as a C constant, with the following extensions:
 .Pp
 otherwise it is evaluated as a C constant, with the following extensions:
 .Pp

-.Df I
+.Bl -bullet -offset indent -compact
+.It

 A leading plus or minus sign is allowed.
 A leading plus or minus sign is allowed.

-.br
+.It

 If the leading character is a single or double quote, or not a digit,
 plus, or minus sign, the value is the ASCII code of the next character.
 If the leading character is a single or double quote, or not a digit,
 plus, or minus sign, the value is the ASCII code of the next character.

-.De
+.El

 .Pp
 The format string is reused as often as necessary to satisfy the
 .Ar arguments  .
 .Pp
 The format string is reused as often as necessary to satisfy the
 .Ar arguments  .


@@ -62,45 +79,47 @@ Any extra format specifications are evaluated with zero or the null
 string.
 .Pp
 Character escape sequences are in backslash notation as defined in the
 string.
 .Pp
 Character escape sequences are in backslash notation as defined in the

-draft proposed ANSI C Standard X3J11.  The characters and their meanings
+draft proposed
+.Tn ANSI C
+Standard
+.Tn X3J11 .
+The characters and their meanings

 are as follows:
 are as follows:

-.Tw Ds
-.Tp Cm \ea
+.Bl -tag -width Ds -offset indent
+.It Cm \ea

 Write a <bell> character.
 Write a <bell> character.

-.Tp Cm \eb
+.It Cm \eb

 Write a <backspace> character.
 Write a <backspace> character.

-.Tp Cm \ef
+.It Cm \ef

 Write a <form-feed> character.
 Write a <form-feed> character.

-.Tp Cm \en
+.It Cm \en

 Write a <new-line> character.
 Write a <new-line> character.

-.Tp Cm \er
+.It Cm \er

 Write a <carriage return> character.
 Write a <carriage return> character.

-.Tp Cm \et
+.It Cm \et

 Write a <tab> character.
 Write a <tab> character.

-.Tp Cm \ev
+.It Cm \ev

 Write a <vertical tab> character.
 Write a <vertical tab> character.

-.Tp Cm \e\'
+.It Cm \e\'

 Write a <single quote> character.
 Write a <single quote> character.

-.Tp Cm \e\e
+.It Cm \e\e

 Write a backslash character.
 Write a backslash character.

-.Tp Cx Cm \e
-.Ar num
-.Cx
-Write an 8-bit character whose ASCII value is the 1-, 2-, or 3-digit
+.It Cm \e Ns Ar num 
+Write an 8-bit character whose
+.Tn ASCII
+value is the 1-, 2-, or 3-digit

 octal number
 octal number

-.Ar num  .
-.Tp
+.Ar num .
+.El

 .Pp
 Each format specification is introduced by the percent character
 (``%'').
 .Pp
 Each format specification is introduced by the percent character
 (``%'').

-The remainder of the format specification includes, in the
-following order:
-.Pp
-Zero or more of the following flags:
-.Pp
-.Ds I
-.Tw Ds
-.Tp Cm #
+The remainder of the format specification includes,
+in the following order:
+.Bl -tag -width Ds
+.It "Zero or more of the following flags:"
+.Bl -tag -width Ds
+.It Cm #

 A `#' character
 specifying that the value should be printed in an ``alternate form''.
 For
 A `#' character
 specifying that the value should be printed in an ``alternate form''.
 For


@@ -132,31 +151,28 @@ and
 .Cm G
 formats, trailing zeros are not removed from the result as they
 would otherwise be;
 .Cm G
 formats, trailing zeros are not removed from the result as they
 would otherwise be;

-.Tp Cm \&\-
+.It Cm \&\-

 A minus sign `\-' which specifies
 .Em left adjustment
 of the output in the indicated field;
 A minus sign `\-' which specifies
 .Em left adjustment
 of the output in the indicated field;

-.Tp Cm \&+
+.It Cm \&+

 A `+' character specifying that there should always be
 a sign placed before the number when using signed formats.
 A `+' character specifying that there should always be
 a sign placed before the number when using signed formats.

-.Tp Sq \&\ \&
+.It Sq \&\ \&

 A space specifying that a blank should be left before a positive number
 for a signed format.  A `+' overrides a space if both are used;
 A space specifying that a blank should be left before a positive number
 for a signed format.  A `+' overrides a space if both are used;

-.Tp Cm \&0
+.It Cm \&0

 A zero `0' character indicating that zero-padding should be used
 rather than blank-padding.  A `\-' overrides a `0' if both are used;
 A zero `0' character indicating that zero-padding should be used
 rather than blank-padding.  A `\-' overrides a `0' if both are used;

-.Tp
-.De
-.Pp 
-.Tw Ds
-.Tp Field Width:
+.El
+.It "Field Width:"

 An optional digit string specifying a
 .Em field width ;
 if the output string has fewer characters than the field width it will
 be blank-padded on the left (or right, if the left-adjustment indicator
 has been given) to make up the field width (note that a leading zero
 is a flag, but an embedded zero is part of a field width);
 An optional digit string specifying a
 .Em field width ;
 if the output string has fewer characters than the field width it will
 be blank-padded on the left (or right, if the left-adjustment indicator
 has been given) to make up the field width (note that a leading zero
 is a flag, but an embedded zero is part of a field width);

-.Tp Precision:
+.It Precision:

 An optional period,
 .Sq Cm \&.\& ,
 followed by an optional digit string giving a
 An optional period,
 .Sq Cm \&.\& ,
 followed by an optional digit string giving a


@@ -169,10 +185,10 @@ and
 formats, or the maximum number of characters to be printed
 from a string; if the digit string is missing, the precision is treated
 as zero;
 formats, or the maximum number of characters to be printed
 from a string; if the digit string is missing, the precision is treated
 as zero;

-.Tp Format:
+.It Format:

 A character which indicates the type of format to use (one of
 .Cm diouxXfwEgGcs ) .
 A character which indicates the type of format to use (one of
 .Cm diouxXfwEgGcs ) .

-.Tp
+.El

 .Pp
 A field width or precision may be
 .Sq Cm \&*
 .Pp
 A field width or precision may be
 .Sq Cm \&*


@@ -182,13 +198,13 @@ In this case an
 supplies the field width or precision.
 .Pp
 The format characters and their meanings are:
 supplies the field width or precision.
 .Pp
 The format characters and their meanings are:

-.Tw Fl
-.Tp Cm diouXx
+.Bl -tag -width Fl
+.It Cm diouXx

 The
 .Ar argument
 is printed as a signed decimal (d or i), unsigned decimal, unsigned octal,
 or unsigned hexadecimal (X or x), respectively.
 The
 .Ar argument
 is printed as a signed decimal (d or i), unsigned decimal, unsigned octal,
 or unsigned hexadecimal (X or x), respectively.

-.Tp Cm f
+.It Cm f

 The
 .Ar argument
 is printed in the style `[\-]ddd.ddd' where the number of d's
 The
 .Ar argument
 is printed in the style `[\-]ddd.ddd' where the number of d's


@@ -196,20 +212,18 @@ after the decimal point is equal to the precision specification for
 the argument.
 If the precision is missing, 6 digits are given; if the precision
 is explicitly 0, no digits and no decimal point are printed.
 the argument.
 If the precision is missing, 6 digits are given; if the precision
 is explicitly 0, no digits and no decimal point are printed.

-.Tp Cm eE
+.It Cm eE

 The
 .Ar argument
 is printed in the style
 The
 .Ar argument
 is printed in the style

-.Cx `[-]d.ddd

 .Cm e
 .Cm e

-.Cx \(+-dd\'
-.Cx
+.`[-]d.ddd Ns \(+-dd\' 

 where there
 is one digit before the decimal point and the number after is equal to
 the precision specification for the argument; when the precision is
 missing, 6 digits are produced.
 An upper-case E is used for an `E' format.
 where there
 is one digit before the decimal point and the number after is equal to
 the precision specification for the argument; when the precision is
 missing, 6 digits are produced.
 An upper-case E is used for an `E' format.

-.Tp Cm gG
+.It Cm gG

 The
 .Ar argument
 is printed in style
 The
 .Ar argument
 is printed in style


@@ -218,35 +232,41 @@ or in style
 .Cm e
 .Pq Cm E
 whichever gives full precision in minimum space.
 .Cm e
 .Pq Cm E
 whichever gives full precision in minimum space.

-.Tp Cm c
+.It Cm c

 The first character of
 .Ar argument
 is printed.
 The first character of
 .Ar argument
 is printed.

-.Tp Cm s
+.It Cm s

 Characters from the string
 .Ar argument
 are printed until the end is reached or until the number of characters
 indicated by the precision specification is reached; however if the
 precision is 0 or missing, all characters in the string are printed.
 Characters from the string
 .Ar argument
 are printed until the end is reached or until the number of characters
 indicated by the precision specification is reached; however if the
 precision is 0 or missing, all characters in the string are printed.

-.Tp Cm \&%
+.It Cm \&%

 Print a `%'; no argument is used.
 Print a `%'; no argument is used.

-.Tp
+.El

 .Pp
 In no case does a non-existent or small field width cause truncation of
 a field; padding takes place only if the specified field width exceeds
 the actual width.
 .Pp
 In no case does a non-existent or small field width cause truncation of
 a field; padding takes place only if the specified field width exceeds
 the actual width.

-.Sh RETURN VALUE
+.Sh RETURN VALUES

 .Nm Printf
 exits 0 on success, 1 on failure.
 .Sh SEE ALSO
 .Xr printf 3
 .Sh HISTORY
 .Nm Printf
 exits 0 on success, 1 on failure.
 .Sh SEE ALSO
 .Xr printf 3
 .Sh HISTORY

-.Nm Printf
-as a command, appears in 4.3+Reno BSD.  It is modeled
+The
+.Nm printf
+command appeared in
+.Bx 4.3 Reno .
+It is modeled

 after the standard library function,
 .Xr printf 3 .
 .Sh BUGS
 after the standard library function,
 .Xr printf 3 .
 .Sh BUGS

-Since the number is translated from ASCII to floating-point, and
+Since the number is translated from
+.Tn ASCII
+to floating-point, and

 then back again, floating-point precision may be lost.
 .Pp
 then back again, floating-point precision may be lost.
 .Pp

-ANSI hexadecimal character constants were deliberately not provided.
+.Tn ANSI
+hexadecimal character constants were deliberately not provided.