diff options
author | Lars Wirzenius <liw@liw.fi> | 2016-02-19 18:26:36 +0200 |
---|---|---|
committer | Lars Wirzenius <liw@liw.fi> | 2016-02-19 18:27:29 +0200 |
commit | 510a8867c44b83a2f6f5d279749a4713c2c06081 (patch) | |
tree | f0376aa96ba48b0e7589a99ed24d8b9cb88a0e50 /cliapp.5 | |
parent | 8df6c12990a3b45dab78fe80b0140b13e969845f (diff) | |
download | cliapp-510a8867c44b83a2f6f5d279749a4713c2c06081.tar.gz |
Add description of byte sizes to cliapp(5)
Diffstat (limited to 'cliapp.5')
-rw-r--r-- | cliapp.5 | 26 |
1 files changed, 26 insertions, 0 deletions
@@ -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. |