summaryrefslogtreecommitdiff
path: root/humanify.1
diff options
context:
space:
mode:
Diffstat (limited to 'humanify.1')
-rw-r--r--humanify.144
1 files changed, 44 insertions, 0 deletions
diff --git a/humanify.1 b/humanify.1
new file mode 100644
index 0000000..dcb80fb
--- /dev/null
+++ b/humanify.1
@@ -0,0 +1,44 @@
+.\" Copyright 2011 Lars Wirzenius <liw@liw.fi>
+.\"
+.\" This program is free software: you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
+.\"
+.TH HUMANIFY 1
+.SH NAME
+humanify \- format bit- and byte-sizes into human-readable form
+.SH SYNOPSIS
+.B humanify
+.RB [ \-\-binary ]
+.RI [ size ...]
+.SH DESCRIPTION
+.B humanify
+formats in human-readable form data sizes (number of bits or bytes).
+For example,
+it can turn
+.I 1234
+into
+.I "1 kB"
+or
+.IR "1 KiB" .
+Sizes are given on the command line,
+or one-per line in the standard input.
+Sizes are rounded to the nearest integer.
+.SH OPTIONS
+.TP
+.BR \-\-binary
+Use 2-based prefixes (from IEC),
+rather than 10-based ones (from ISO).
+In other words, "kibibyte" instead of "kilobyte".
+.TP
+.BR \-\-bits
+Inputs give number of bits, instead of bytes.