| 1 |
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.50.1. |
| 2 |
.TH BASENC "1" "February 2026" "GNU coreutils 9.10" "User Commands" |
| 3 |
.SH NAME |
| 4 |
basenc \- Encode/decode data and print to standard output |
| 5 |
.SH SYNOPSIS |
| 6 |
.B basenc |
| 7 |
[\fI\,OPTION\/\fR]... [\fI\,FILE\/\fR] |
| 8 |
.SH DESCRIPTION |
| 9 |
.\" Add any additional description here |
| 10 |
.PP |
| 11 |
basenc encode or decode FILE, or standard input, to standard output. |
| 12 |
.PP |
| 13 |
With no FILE, or when FILE is \-, read standard input. |
| 14 |
.PP |
| 15 |
Mandatory arguments to long options are mandatory for short options too. |
| 16 |
.TP |
| 17 |
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--base64'\fB\-\-base64\fP\X'tty: link' |
| 18 |
same as 'base64' program (RFC4648 section 4) |
| 19 |
.TP |
| 20 |
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--base64url'\fB\-\-base64url\fP\X'tty: link' |
| 21 |
file\- and url\-safe base64 (RFC4648 section 5) |
| 22 |
.TP |
| 23 |
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--base58'\fB\-\-base58\fP\X'tty: link' |
| 24 |
visually unambiguous base58 encoding |
| 25 |
.TP |
| 26 |
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--base32'\fB\-\-base32\fP\X'tty: link' |
| 27 |
same as 'base32' program (RFC4648 section 6) |
| 28 |
.TP |
| 29 |
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--base32hex'\fB\-\-base32hex\fP\X'tty: link' |
| 30 |
extended hex alphabet base32 (RFC4648 section 7) |
| 31 |
.TP |
| 32 |
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--base16'\fB\-\-base16\fP\X'tty: link' |
| 33 |
hex encoding (RFC4648 section 8) |
| 34 |
.TP |
| 35 |
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--base2msbf'\fB\-\-base2msbf\fP\X'tty: link' |
| 36 |
bit string with most significant bit (msb) first |
| 37 |
.TP |
| 38 |
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--base2lsbf'\fB\-\-base2lsbf\fP\X'tty: link' |
| 39 |
bit string with least significant bit (lsb) first |
| 40 |
.TP |
| 41 |
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc-d'\fB\-d, \-\-decode\fP\X'tty: link' |
| 42 |
decode data |
| 43 |
.TP |
| 44 |
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc-i'\fB\-i, \-\-ignore\-garbage\fP\X'tty: link' |
| 45 |
when decoding, ignore non\-alphabet characters |
| 46 |
.TP |
| 47 |
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc-w'\fB\-w, \-\-wrap=\,COLS\fP\X'tty: link'\/\fR |
| 48 |
wrap encoded lines after COLS character (default 76). |
| 49 |
Use 0 to disable line wrapping |
| 50 |
.TP |
| 51 |
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--z85'\fB\-\-z85\fP\X'tty: link' |
| 52 |
ascii85\-like encoding (ZeroMQ spec:32/Z85); |
| 53 |
when encoding, input length must be a multiple of 4; |
| 54 |
when decoding, input length must be a multiple of 5 |
| 55 |
.TP |
| 56 |
\X'tty: link https://www.gnu.org/software/coreutils/basenc#basenc--help'\fB\-\-help\fP\X'tty: link' |
| 57 |
display this help and exit |
| 58 |
.TP |
| 59 |
\X'tty: link https://www.gnu.org/software/coreutils/basenc#basenc--version'\fB\-\-version\fP\X'tty: link' |
| 60 |
output version information and exit |
| 61 |
.PP |
| 62 |
When decoding, the input may contain newlines in addition to the bytes of |
| 63 |
the formal alphabet. Use \fB\-\-ignore\-garbage\fR to attempt to recover |
| 64 |
from any other non\-alphabet bytes in the encoded stream. |
| 65 |
.SH "ENCODING EXAMPLES" |
| 66 |
.PP |
| 67 |
.nf |
| 68 |
.RS |
| 69 |
$ printf '\\376\\117\\202' | basenc \-\-base64 |
| 70 |
/k+C |
| 71 |
|
| 72 |
$ printf '\\376\\117\\202' | basenc \-\-base64url |
| 73 |
_k-C |
| 74 |
|
| 75 |
$ printf '\\376\\117\\202' | basenc \-\-base32 |
| 76 |
7ZHYE=== |
| 77 |
|
| 78 |
$ printf '\\376\\117\\202' | basenc \-\-base32hex |
| 79 |
VP7O4=== |
| 80 |
|
| 81 |
$ printf '\\376\\117\\202' | basenc \-\-base16 |
| 82 |
FE4F82 |
| 83 |
|
| 84 |
$ printf '\\376\\117\\202' | basenc \-\-base2lsbf |
| 85 |
011111111111001001000001 |
| 86 |
|
| 87 |
$ printf '\\376\\117\\202' | basenc \-\-base2msbf |
| 88 |
111111100100111110000010 |
| 89 |
|
| 90 |
$ printf '\\376\\117\\202\\000' | basenc \-\-z85 |
| 91 |
@.FaC |
| 92 |
.RE |
| 93 |
.fi |
| 94 |
.SH AUTHOR |
| 95 |
Written by Simon Josefsson and Assaf Gordon. |
| 96 |
.SH "REPORTING BUGS" |
| 97 |
Report bugs to: bug\[email protected] |
| 98 |
.br |
| 99 |
GNU coreutils home page: <https://www.gnu.org/software/coreutils/> |
| 100 |
.br |
| 101 |
General help using GNU software: <https://www.gnu.org/gethelp/> |
| 102 |
.br |
| 103 |
Report any translation bugs to <https://translationproject.org/team/> |
| 104 |
.SH "SEE ALSO" |
| 105 |
Full documentation <https://www.gnu.org/software/coreutils/basenc> |
| 106 |
.br |
| 107 |
or available locally via: info \(aq(coreutils) basenc invocation\(aq |
| 108 |
.PP |
| 109 |
.br |
| 110 |
Packaged by Debian (9.10\-1) |
| 111 |
.br |
| 112 |
Copyright \(co 2026 Free Software Foundation, Inc. |
| 113 |
.br |
| 114 |
License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. |
| 115 |
.br |
| 116 |
This is free software: you are free to change and redistribute it. |
| 117 |
.br |
| 118 |
There is NO WARRANTY, to the extent permitted by law. |