bin/xbps-query: document format flag

void-linux · Feb 21, 2023 · 8044233 · 8044233
1 parent 89a1704
commit 8044233
Showing 1 changed file with 43 additions and 0 deletions.
diff --git a/bin/xbps-query/xbps-query.1 b/bin/xbps-query/xbps-query.1
@@ -88,6 +88,49 @@ If the first character is not '/' then it's a relative path of
 .Ar rootdir .
 .It Fl d, Fl -debug
 Enables extra debugging shown to stderr.
+.It Fl F, Fl -format Ar format
+Format for list output.
+.Bd -literal
+<substitution> ::= "{" variable ["!" conversion] [":" format] "}"
+<variable>     ::= [a-zA-Z90-9_-]
+
+<conversion>   ::= humanize | strmode
+
+-- Convert inode status information into a symbolic string
+<strmode> ::= "strmode"
+
+-- Format a number into a human readable form, the default is:`humanize .8Ki`:
+<humanize>     ::= "humanize" [space] [decimal] [width] [scale] [i]
+  <space>      ::= " "          -- Put a space between number and the suffix.
+  <decimal>    ::= "."          -- If the final result is less than 10, display
+                                   it using one digit.
+  <width>      ::= [0-9]+       -- Width of the output.
+  <scale>      ::= multiplier   -- Minimum scale multiplier and optionally
+                   [multiplier] -- Maxium scale multiplier.
+  <multiplier> ::= "B"
+                 | "K" -- kilo
+                 | "M" -- mega
+                 | "G" -- giga
+                 | "T" -- tera
+                 | "P" -- peta
+                 | "E" -- exa
+  <i>          ::= "i" -- Divide number with 1000 instead of 1024.
+
+<format>      ::= [[fill] align] [sign] [width] ["." precision] [type]
+  <fill>      ::= <any char> -- The character to use when aligning the output.
+  <align>     ::= "<"        -- Left align.
+                | ">"        -- Right align.
+                | "="        -- Left align with zero paddings after the sign.
+  <sign>      ::= "+"        -- Add sign to positive and negative numbers.
+                | "-"        -- Add sign to negative numbers.
+  <width>     ::= [0-9]+     -- The alignment width.
+  <precision> ::= [0-9]+     -- Percision for numbers.
+  <type>      ::= "d"        -- Decimal number.
+                | "o"        -- Octal number.
+                | "u"        -- Unsigned number.
+                | "x"        -- Hexadecimal with lowercase letters.
+                | "X"        -- Hexadecimal with uppercase letters.
+.Ed
 .It Fl h, Fl -help
 Show the help message.
 .It Fl i, Fl -ignore-conf-repos