RGBCube/uutils-coreutils
1
Fork 0
mirror of https://github.com/RGBCube/uutils-coreutils synced 2025-07-28 03:27:44 +00:00
Code Issues Activity

printf: resolve formatting nit in LONGHELP strings

Browse source 
Removed 1 preceeding space for LONGHELP_LEAD and 2 preceeding spaces for LONGHELP_BODY
This commit is contained in:
Nathan 2022-02-01 22:22:12 -05:00
parent f6174dd946
commit 29b613a852
1 changed files with 167 additions and 167 deletions
Download patch file Download diff file Expand all files Collapse all files

334
src/uu/printf/src/printf.rs
View file

@ -13,13 +13,13 @@ const USAGE: &str = "printf FORMATSTRING [ARGUMENT]...";
const ABOUT: &str = "Print output based off of the format string and proceeding arguments."; const ABOUT: &str = "Print output based off of the format string and proceeding arguments.";
static LONGHELP_LEAD: &str = "printf static LONGHELP_LEAD: &str = "printf
USAGE: printf FORMATSTRING [ARGUMENT]... USAGE: printf FORMATSTRING [ARGUMENT]...
basic anonymous string templating: basic anonymous string templating:
prints format string at least once, repeating as long as there are remaining arguments prints format string at least once, repeating as long as there are remaining arguments
output prints escaped literals in the format string as character literals output prints escaped literals in the format string as character literals
output replaces anonymous fields with the next unused argument, formatted according to the field. output replaces anonymous fields with the next unused argument, formatted according to the field.
Options: Options:
--help display this help and exit --help display this help and exit
@ -27,239 +27,239 @@ Options:
"; ";
static LONGHELP_BODY: &str = " static LONGHELP_BODY: &str = "
Prints the , replacing escaped character sequences with character literals Prints the , replacing escaped character sequences with character literals
and substitution field sequences with passed arguments and substitution field sequences with passed arguments
literally, with the exception of the below literally, with the exception of the below
escaped character sequences, and the substitution sequences described further down. escaped character sequences, and the substitution sequences described further down.
ESCAPE SEQUENCES ESCAPE SEQUENCES
The following escape sequences, organized here in alphabetical order, The following escape sequences, organized here in alphabetical order,
will print the corresponding character literal: will print the corresponding character literal:
\" double quote \" double quote
\\\\ backslash \\\\ backslash
\\a alert (BEL) \\a alert (BEL)
\\b backspace \\b backspace
\\c End-of-Input \\c End-of-Input
\\e escape \\e escape
\\f form feed \\f form feed
\\n new line \\n new line
\\r carriage return \\r carriage return
\\t horizontal tab \\t horizontal tab
\\v vertical tab \\v vertical tab
\\NNN byte with value expressed in octal value NNN (1 to 3 digits) \\NNN byte with value expressed in octal value NNN (1 to 3 digits)
values greater than 256 will be treated values greater than 256 will be treated
\\xHH byte with value expressed in hexadecimal value NN (1 to 2 digits) \\xHH byte with value expressed in hexadecimal value NN (1 to 2 digits)
\\uHHHH Unicode (IEC 10646) character with value expressed in hexadecimal value HHHH (4 digits) \\uHHHH Unicode (IEC 10646) character with value expressed in hexadecimal value HHHH (4 digits)
\\uHHHH Unicode character with value expressed in hexadecimal value HHHH (8 digits) \\uHHHH Unicode character with value expressed in hexadecimal value HHHH (8 digits)
%% a single % %% a single %
SUBSTITUTIONS SUBSTITUTIONS
SUBSTITUTION QUICK REFERENCE SUBSTITUTION QUICK REFERENCE
Fields Fields
%s - string %s - string
%b - string parsed for literals %b - string parsed for literals
second parameter is max length second parameter is max length
%c - char %c - char
no second parameter no second parameter
%i or %d - 64-bit integer %i or %d - 64-bit integer
%u - 64 bit unsigned integer %u - 64 bit unsigned integer
%x or %X - 64-bit unsigned integer as hex %x or %X - 64-bit unsigned integer as hex
%o - 64-bit unsigned integer as octal %o - 64-bit unsigned integer as octal
second parameter is min-width, integer second parameter is min-width, integer
output below that width is padded with leading zeroes output below that width is padded with leading zeroes
%f or %F - decimal floating point value %f or %F - decimal floating point value
%e or %E - scientific notation floating point value %e or %E - scientific notation floating point value
%g or %G - shorter of specially interpreted decimal or SciNote floating point value. %g or %G - shorter of specially interpreted decimal or SciNote floating point value.
second parameter is second parameter is
-max places after decimal point for floating point output -max places after decimal point for floating point output
-max number of significant digits for scientific notation output -max number of significant digits for scientific notation output
parameterizing fields parameterizing fields
examples: examples:
printf '%4.3i' 7 printf '%4.3i' 7
has a first parameter of 4 has a first parameter of 4
and a second parameter of 3 and a second parameter of 3
will result in ' 007' will result in ' 007'
printf '%.1s' abcde printf '%.1s' abcde
has no first parameter has no first parameter
and a second parameter of 1 and a second parameter of 1
will result in 'a' will result in 'a'
printf '%4c' q printf '%4c' q
has a first parameter of 4 has a first parameter of 4
and no second parameter and no second parameter
will result in ' q' will result in ' q'
The first parameter of a field is the minimum width to pad the output to The first parameter of a field is the minimum width to pad the output to
if the output is less than this absolute value of this width, if the output is less than this absolute value of this width,
it will be padded with leading spaces, or, if the argument is negative, it will be padded with leading spaces, or, if the argument is negative,
with trailing spaces. the default is zero. with trailing spaces. the default is zero.
The second parameter of a field is particular to the output field type. The second parameter of a field is particular to the output field type.
defaults can be found in the full substitution help below defaults can be found in the full substitution help below
special prefixes to numeric arguments special prefixes to numeric arguments
0 (e.g. 010) - interpret argument as octal (integer output fields only) 0 (e.g. 010) - interpret argument as octal (integer output fields only)
0x (e.g. 0xABC) - interpret argument as hex (numeric output fields only) 0x (e.g. 0xABC) - interpret argument as hex (numeric output fields only)
\' (e.g. \'a) - interpret argument as a character constant \' (e.g. \'a) - interpret argument as a character constant
HOW TO USE SUBSTITUTIONS HOW TO USE SUBSTITUTIONS
Substitutions are used to pass additional argument(s) into the FORMAT string, to be formatted a Substitutions are used to pass additional argument(s) into the FORMAT string, to be formatted a
particular way. E.g. particular way. E.g.
printf 'the letter %X comes before the letter %X' 10 11 printf 'the letter %X comes before the letter %X' 10 11
will print will print
'the letter A comes before the letter B' 'the letter A comes before the letter B'
because the substitution field %X means because the substitution field %X means
'take an integer argument and write it as a hexadecimal number' 'take an integer argument and write it as a hexadecimal number'
Passing more arguments than are in the format string will cause the format string to be Passing more arguments than are in the format string will cause the format string to be
repeated for the remaining substitutions repeated for the remaining substitutions
printf 'it is %i F in %s \n' 22 Portland 25 Boston 27 New York printf 'it is %i F in %s \n' 22 Portland 25 Boston 27 New York
will print will print
'it is 22 F in Portland 'it is 22 F in Portland
it is 25 F in Boston it is 25 F in Boston
it is 27 F in Boston it is 27 F in Boston
' '
If a format string is printed but there are less arguments remaining If a format string is printed but there are less arguments remaining
than there are substitution fields, substitution fields without than there are substitution fields, substitution fields without
an argument will default to empty strings, or for numeric fields an argument will default to empty strings, or for numeric fields
the value 0 the value 0
AVAILABLE SUBSTITUTIONS AVAILABLE SUBSTITUTIONS
This program, like GNU coreutils printf, This program, like GNU coreutils printf,
interprets a modified subset of the POSIX C printf spec, interprets a modified subset of the POSIX C printf spec,
a quick reference to substitutions is below. a quick reference to substitutions is below.
STRING SUBSTITUTIONS STRING SUBSTITUTIONS
All string fields have a 'max width' parameter All string fields have a 'max width' parameter
%.3s means 'print no more than three characters of the original input' %.3s means 'print no more than three characters of the original input'
%s - string %s - string
%b - escaped string - the string will be checked for any escaped literals from %b - escaped string - the string will be checked for any escaped literals from
the escaped literal list above, and translate them to literal characters. the escaped literal list above, and translate them to literal characters.
e.g. \\n will be transformed into a newline character. e.g. \\n will be transformed into a newline character.
One special rule about %b mode is that octal literals are interpreted differently One special rule about %b mode is that octal literals are interpreted differently
In arguments passed by %b, pass octal-interpreted literals must be in the form of \\0NNN In arguments passed by %b, pass octal-interpreted literals must be in the form of \\0NNN
instead of \\NNN. (Although, for legacy reasons, octal literals in the form of \\NNN will instead of \\NNN. (Although, for legacy reasons, octal literals in the form of \\NNN will
still be interpreted and not throw a warning, you will have problems if you use this for a still be interpreted and not throw a warning, you will have problems if you use this for a
literal whose code begins with zero, as it will be viewed as in \\0NNN form.) literal whose code begins with zero, as it will be viewed as in \\0NNN form.)
CHAR SUBSTITUTIONS CHAR SUBSTITUTIONS
The character field does not have a secondary parameter. The character field does not have a secondary parameter.
%c - a single character %c - a single character
INTEGER SUBSTITUTIONS INTEGER SUBSTITUTIONS
All integer fields have a 'pad with zero' parameter All integer fields have a 'pad with zero' parameter
%.4i means an integer which if it is less than 4 digits in length, %.4i means an integer which if it is less than 4 digits in length,
is padded with leading zeros until it is 4 digits in length. is padded with leading zeros until it is 4 digits in length.
%d or %i - 64-bit integer %d or %i - 64-bit integer
%u - 64 bit unsigned integer %u - 64 bit unsigned integer
%x or %X - 64 bit unsigned integer printed in Hexadecimal (base 16) %x or %X - 64 bit unsigned integer printed in Hexadecimal (base 16)
%X instead of %x means to use uppercase letters for 'a' through 'f' %X instead of %x means to use uppercase letters for 'a' through 'f'
%o - 64 bit unsigned integer printed in octal (base 8) %o - 64 bit unsigned integer printed in octal (base 8)
FLOATING POINT SUBSTITUTIONS FLOATING POINT SUBSTITUTIONS
All floating point fields have a 'max decimal places / max significant digits' parameter All floating point fields have a 'max decimal places / max significant digits' parameter
%.10f means a decimal floating point with 7 decimal places past 0 %.10f means a decimal floating point with 7 decimal places past 0
%.10e means a scientific notation number with 10 significant digits %.10e means a scientific notation number with 10 significant digits
%.10g means the same behavior for decimal and Sci. Note, respectively, and provides the shorter %.10g means the same behavior for decimal and Sci. Note, respectively, and provides the shorter
of each's output. of each's output.
Like with GNU coreutils, the value after the decimal point is these outputs is parsed as a Like with GNU coreutils, the value after the decimal point is these outputs is parsed as a
double first before being rendered to text. For both implementations do not expect meaningful double first before being rendered to text. For both implementations do not expect meaningful
precision past the 18th decimal place. When using a number of decimal places that is 18 or precision past the 18th decimal place. When using a number of decimal places that is 18 or
higher, you can expect variation in output between GNU coreutils printf and this printf at the higher, you can expect variation in output between GNU coreutils printf and this printf at the
18th decimal place of +/- 1 18th decimal place of +/- 1
%f - floating point value presented in decimal, truncated and displayed to 6 decimal places by %f - floating point value presented in decimal, truncated and displayed to 6 decimal places by
default. There is not past-double behavior parity with Coreutils printf, values are not default. There is not past-double behavior parity with Coreutils printf, values are not
estimated or adjusted beyond input values. estimated or adjusted beyond input values.
%e or %E - floating point value presented in scientific notation %e or %E - floating point value presented in scientific notation
7 significant digits by default 7 significant digits by default
%E means use to use uppercase E for the mantissa. %E means use to use uppercase E for the mantissa.
%g or %G - floating point value presented in the shorter of decimal and scientific notation %g or %G - floating point value presented in the shorter of decimal and scientific notation
behaves differently from %f and %E, please see posix printf spec for full details, behaves differently from %f and %E, please see posix printf spec for full details,
some examples of different behavior: some examples of different behavior:
Sci Note has 6 significant digits by default Sci Note has 6 significant digits by default
Trailing zeroes are removed Trailing zeroes are removed
Instead of being truncated, digit after last is rounded Instead of being truncated, digit after last is rounded
Like other behavior in this utility, the design choices of floating point Like other behavior in this utility, the design choices of floating point
behavior in this utility is selected to reproduce in exact behavior in this utility is selected to reproduce in exact
the behavior of GNU coreutils' printf from an inputs and outputs standpoint. the behavior of GNU coreutils' printf from an inputs and outputs standpoint.
USING PARAMETERS USING PARAMETERS
Most substitution fields can be parameterized using up to 2 numbers that can Most substitution fields can be parameterized using up to 2 numbers that can
be passed to the field, between the % sign and the field letter. be passed to the field, between the % sign and the field letter.
The 1st parameter always indicates the minimum width of output, it is useful for creating The 1st parameter always indicates the minimum width of output, it is useful for creating
columnar output. Any output that would be less than this minimum width is padded with columnar output. Any output that would be less than this minimum width is padded with
leading spaces leading spaces
The 2nd parameter is proceeded by a dot. The 2nd parameter is proceeded by a dot.
You do not have to use parameters You do not have to use parameters
SPECIAL FORMS OF INPUT SPECIAL FORMS OF INPUT
For numeric input, the following additional forms of input are accepted besides decimal: For numeric input, the following additional forms of input are accepted besides decimal:
Octal (only with integer): if the argument begins with a 0 the proceeding characters Octal (only with integer): if the argument begins with a 0 the proceeding characters
will be interpreted as octal (base 8) for integer fields will be interpreted as octal (base 8) for integer fields
Hexadecimal: if the argument begins with 0x the proceeding characters will be interpreted Hexadecimal: if the argument begins with 0x the proceeding characters will be interpreted
will be interpreted as hex (base 16) for any numeric fields will be interpreted as hex (base 16) for any numeric fields
for float fields, hexadecimal input results in a precision for float fields, hexadecimal input results in a precision
limit (in converting input past the decimal point) of 10^-15 limit (in converting input past the decimal point) of 10^-15
Character Constant: if the argument begins with a single quote character, the first byte Character Constant: if the argument begins with a single quote character, the first byte
of the next character will be interpreted as an 8-bit unsigned integer. If there are of the next character will be interpreted as an 8-bit unsigned integer. If there are
additional bytes, they will throw an error (unless the environment variable POSIXLY_CORRECT additional bytes, they will throw an error (unless the environment variable POSIXLY_CORRECT
is set) is set)
WRITTEN BY : WRITTEN BY :
Nathan E. Ross, et al. for the uutils project Nathan E. Ross, et al. for the uutils project