summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPádraig Brady <P@draigBrady.com>2015-08-05 10:28:36 +0200
committerPádraig Brady <P@draigBrady.com>2015-09-03 00:33:19 +0100
commit89c517d9e26ad232d857ba37d897adbef19b30a9 (patch)
tree2dd50c147bcfa66c9ce05e5b4923e1910077ba81 /doc
parentaffc8e8087ed6c2575d32e21df2986747f5852ee (diff)
downloadcoreutils-89c517d9e26ad232d857ba37d897adbef19b30a9.tar.xz
base32: A new program similar to base64
Suggested in https://bugzilla.redhat.com/1250113 * AUTHORS: Add base32. * THANKS.in: Add suggester. * README: Reference the new program. * NEWS: Mention the new program. * src/.gitignore: Ignore the new binary. * bootstrap.conf: Reference the gnulib base32 module. * build-aux/gen-lists-of-programs.sh: Add base32. * man/base32.x: A new template. * man/.gitignore: Ignore the new man page. * man/local.mk: Reference the new man page. * doc/coreutils.texi (base32 invocation): Document the new command. * src/local.mk: Adjust to build base32 based on base64.c. * src/base64.c: Parameterize to use the correct headers, functions and buffer sizes, depending on which binary is being built. * tests/misc/base64.pl: Adjust to test both base32 and base64. * tests/misc/tty-eof.pl: Add base32 as a program that accepts input on stdin without any options specified. * scripts/git-hooks/commit-msg: Add base32 to the template.
Diffstat (limited to 'doc')
-rw-r--r--doc/coreutils.texi20
1 files changed, 19 insertions, 1 deletions
diff --git a/doc/coreutils.texi b/doc/coreutils.texi
index c35401f99..5589162e5 100644
--- a/doc/coreutils.texi
+++ b/doc/coreutils.texi
@@ -37,6 +37,7 @@
@dircategory Individual utilities
@direntry
* arch: (coreutils)arch invocation. Print machine hardware name.
+* base32: (coreutils)base32 invocation. Base32 encode/decode data.
* base64: (coreutils)base64 invocation. Base64 encode/decode data.
* basename: (coreutils)basename invocation. Strip directory and suffix.
* cat: (coreutils)cat invocation. Concatenate and write files.
@@ -183,7 +184,7 @@ Free Documentation License''.
@menu
* Introduction:: Caveats, overview, and authors
* Common options:: Common options
-* Output of entire files:: cat tac nl od base64
+* Output of entire files:: cat tac nl od base32 base64
* Formatting file contents:: fmt pr fold
* Output of parts of files:: head tail split csplit
* Summarizing files:: wc sum cksum md5sum sha1sum sha2
@@ -238,6 +239,7 @@ Output of entire files
* tac invocation:: Concatenate and write files in reverse
* nl invocation:: Number lines and write files
* od invocation:: Write files in octal or other formats
+* base32 invocation:: Transform data into printable data
* base64 invocation:: Transform data into printable data
Formatting file contents
@@ -1551,6 +1553,7 @@ in some way.
* tac invocation:: Concatenate and write files in reverse.
* nl invocation:: Number lines and write files.
* od invocation:: Write files in octal or other formats.
+* base32 invocation:: Transform data into printable data.
* base64 invocation:: Transform data into printable data.
@end menu
@@ -2138,6 +2141,20 @@ address.
@exitstatus
+
+@node base32 invocation
+@section @command{base32}: Transform data into printable data
+
+@pindex base32
+@cindex base32 encoding
+
+@command{base32} transforms data read from a file, or standard input,
+into (or from) base32 encoded form. The base32 encoded form uses
+printable ASCII characters to represent binary data.
+The usage and options of this command are precisely the
+same as for @command{base64}. @xref{base64 invocation}.
+
+
@node base64 invocation
@section @command{base64}: Transform data into printable data
@@ -2155,6 +2172,7 @@ base64 --decode [@var{option}]@dots{} [@var{file}]
@end smallexample
The base64 encoding expands data to roughly 133% of the original.
+The base32 encoding expands data to roughly 160% of the original.
The format conforms to
@uref{ftp://ftp.rfc-editor.org/in-notes/rfc4648.txt, RFC 4648}.