diff options
Diffstat (limited to 'man/basenc.1')
| -rw-r--r-- | man/basenc.1 | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/man/basenc.1 b/man/basenc.1 new file mode 100644 index 0000000..5c216f1 --- /dev/null +++ b/man/basenc.1 @@ -0,0 +1,106 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.5. +.TH BASENC "1" "August 2023" "GNU coreutils 9.4" "User Commands" +.SH NAME +basenc \- Encode/decode data and print to standard output +.SH SYNOPSIS +.B basenc +[\fI\,OPTION\/\fR]... [\fI\,FILE\/\fR] +.SH DESCRIPTION +.\" Add any additional description here +.PP +basenc encode or decode FILE, or standard input, to standard output. +.PP +With no FILE, or when FILE is \-, read standard input. +.PP +Mandatory arguments to long options are mandatory for short options too. +.TP +\fB\-\-base64\fR +same as 'base64' program (RFC4648 section 4) +.TP +\fB\-\-base64url\fR +file\- and url\-safe base64 (RFC4648 section 5) +.TP +\fB\-\-base32\fR +same as 'base32' program (RFC4648 section 6) +.TP +\fB\-\-base32hex\fR +extended hex alphabet base32 (RFC4648 section 7) +.TP +\fB\-\-base16\fR +hex encoding (RFC4648 section 8) +.TP +\fB\-\-base2msbf\fR +bit string with most significant bit (msb) first +.TP +\fB\-\-base2lsbf\fR +bit string with least significant bit (lsb) first +.TP +\fB\-d\fR, \fB\-\-decode\fR +decode data +.TP +\fB\-i\fR, \fB\-\-ignore\-garbage\fR +when decoding, ignore non\-alphabet characters +.TP +\fB\-w\fR, \fB\-\-wrap\fR=\fI\,COLS\/\fR +wrap encoded lines after COLS character (default 76). +Use 0 to disable line wrapping +.TP +\fB\-\-z85\fR +ascii85\-like encoding (ZeroMQ spec:32/Z85); +when encoding, input length must be a multiple of 4; +when decoding, input length must be a multiple of 5 +.TP +\fB\-\-help\fR +display this help and exit +.TP +\fB\-\-version\fR +output version information and exit +.PP +When decoding, the input may contain newlines in addition to the bytes of +the formal alphabet. Use \fB\-\-ignore\-garbage\fR to attempt to recover +from any other non\-alphabet bytes in the encoded stream. +.SH "ENCODING EXAMPLES" +.PP +.nf +.RS +$ printf '\\376\\117\\202' | basenc \-\-base64 +/k+C + +$ printf '\\376\\117\\202' | basenc \-\-base64url +_k-C + +$ printf '\\376\\117\\202' | basenc \-\-base32 +7ZHYE=== + +$ printf '\\376\\117\\202' | basenc \-\-base32hex +VP7O4=== + +$ printf '\\376\\117\\202' | basenc \-\-base16 +FE4F82 + +$ printf '\\376\\117\\202' | basenc \-\-base2lsbf +011111111111001001000001 + +$ printf '\\376\\117\\202' | basenc \-\-base2msbf +111111100100111110000010 + +$ printf '\\376\\117\\202\\000' | basenc \-\-z85 +@.FaC +.RE +.fi +.SH AUTHOR +Written by Simon Josefsson and Assaf Gordon. +.SH "REPORTING BUGS" +GNU coreutils online help: <https://www.gnu.org/software/coreutils/> +.br +Report any translation bugs to <https://translationproject.org/team/> +.SH COPYRIGHT +Copyright \(co 2023 Free Software Foundation, Inc. +License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. +.br +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. +.SH "SEE ALSO" +Full documentation <https://www.gnu.org/software/coreutils/basenc> +.br +or available locally via: info \(aq(coreutils) basenc invocation\(aq |