From 510a8867c44b83a2f6f5d279749a4713c2c06081 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Fri, 19 Feb 2016 18:26:36 +0200 Subject: Add description of byte sizes to cliapp(5) --- NEWS | 3 +++ cliapp.5 | 26 ++++++++++++++++++++++++++ 2 files changed, 29 insertions(+) diff --git a/NEWS b/NEWS index 86d60ba..a512683 100644 --- a/NEWS +++ b/NEWS @@ -9,6 +9,9 @@ Version 1.20151108+git, not yet released `--generate-manpage`. These are not frequently used, but sometimes they are useful, and there's no point making them difficult to find. +* The **cliapp**(5) manual page now documents the units for options + whose value is a size in bytes. + Version 1.20151108, released 2016-01-09 --------------------------------------- diff --git a/cliapp.5 b/cliapp.5 index 93a1c52..21ad2f6 100644 --- a/cliapp.5 +++ b/cliapp.5 @@ -140,6 +140,32 @@ the command line option would also break values with commas. This has since been fixed. .PP Configuration files in YAML use standard YAML syntax to express lists. +.SS "Expressing sizes in bytes" +Some options take a value that gives the size as bytes. +These take an optional unit suffix. +A plain integer is the size in bytes. +The following units are supported: +.TS +tab(:); +lb lb rb rb +l l n n. +suffix:meaning:factor: +_ +k, kb:kilobyte:10**3:1000 +m, mb:megabyte:10**6:1000000 +g, gb:gigabyte:10**9:1000000000 +t, tb:terabyte:10**12:1000000000000 +_ +ki, kib:kibibyte:2**10:1024 +mi, mib:mebibyte:2**20:1048576 +gi, gib:gibibyte:2**30:1073741824 +ti, tib:tebibyte:2**40:1099511627776 +.TE +.PP +Suffixes may be upper or lower case, +without change in meaning. +Note that "b" and "B" are identical, +and both mean byte, not bit. .SS "Boolean (true/false or on/off or yes/no) settings" When a setting can be either on or off, it's called a Boolean setting. -- cgit v1.2.1