.\"formatted output conversion
.TH sprintf 3

.SH NAME
printf, sprintf - formatted output conversion

.SH SYNOPSIS
.nf
void printf(string format, ...)
string sprintf(string format, ...)

.SH DESCRIPTION
An implementation of (s)printf() for LPC, with quite a few extensions
(note that as no floating point exists, some parameters have slightly
different meaning or restrictions to "standard" (s)printf.)
Implemented by Lynscar (Sean A Reith).
.PP
This version supports the following as modifiers:
.TP 6
" "
pad positive integers with a space.
.TP
"+"
pad positive integers with a plus sign.
.TP
"-"
left adjusted within field size.
.br
NB: std (s)printf() defaults to right justification, which is unnatural
in the context of a mainly string based language but has been retained for
"compatability".
.TP
"|"
centered within field size.
.TP
"="
column mode if strings are greater than field size. This is only
meaningful with strings, all other types ignore this. Columns are
auto-magically word wrapped.
.TP
"#"
table mode, print a list of '\n' separated 'words' in a
table within the field size.  only meaningful with strings.
.TP
n
specifies the field size, a '*' specifies to use the corresponding
arg as the field size.  If n is prepended with a zero, then is padded
zeros, else it is padded with spaces (or specified pad string).
.TP
"."n
precision of n, simple strings truncate after this (if precision is
greater than field size, then field size = precision), tables use
precision to specify the number of columns (if precision not specified
then tables calculate a best fit), all other types ignore this.
.TP
":"n
n specifies the fs _and_ the precision, if n is prepended by a zero
then it is padded with zeros instead of spaces.
.TP
"@"
the argument is an array.  the corresponding format_info (minus the
"@") is applyed to each element of the array.
.TP
"\'X\'"
The char(s) between the single-quotes are used to pad to field
size (defaults to space) (if both a zero (in front of field
size) and a pad string are specified, the one specified second
overrules).  NOTE:  to include "'" in the pad string, you must
use "\\'" (as the backslash has to be escaped past the
interpreter), similarly, to include "\" requires "\\\\".
.PP
The following are the possible type specifiers.
.TP 8
%
in which case no arguments are interpreted, and a "%" is inserted, and
all modifiers are ignored.
.TP
O
the argument is an LPC datatype.
.TP
s
the argument is a string.
.TP
d, i
the integer arg is printed in decimal.
.TP
c
the integer arg is to be printed as a character.
.TP
o
the integer arg is printed in octal.
.TP
x
the integer arg is printed in hex.
.TP
X
the integer arg is printed in hex (with A-F in capitals).

.SH RETURN VALUES
sprintf() returns the formatted string.

.SH AUTHOR
Sean A. Reith (Lynscar)

.SH SEE ALSO
sscanf(3)