File: basenc.1

package info (click to toggle)
coreutils 9.10-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 70,560 kB
  • sloc: ansic: 253,546; sh: 30,931; perl: 8,141; yacc: 1,846; makefile: 198; python: 47; sed: 16
file content (113 lines) | stat: -rw-r--r-- 4,462 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.50.1.
.TH BASENC "1" "February 2026" "GNU coreutils 9.10" "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
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--base64'\fB\-\-base64\fP\X'tty: link'
same as 'base64' program (RFC4648 section 4)
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--base64url'\fB\-\-base64url\fP\X'tty: link'
file\- and url\-safe base64 (RFC4648 section 5)
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--base58'\fB\-\-base58\fP\X'tty: link'
visually unambiguous base58 encoding
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--base32'\fB\-\-base32\fP\X'tty: link'
same as 'base32' program (RFC4648 section 6)
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--base32hex'\fB\-\-base32hex\fP\X'tty: link'
extended hex alphabet base32 (RFC4648 section 7)
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--base16'\fB\-\-base16\fP\X'tty: link'
hex encoding (RFC4648 section 8)
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--base2msbf'\fB\-\-base2msbf\fP\X'tty: link'
bit string with most significant bit (msb) first
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--base2lsbf'\fB\-\-base2lsbf\fP\X'tty: link'
bit string with least significant bit (lsb) first
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc-d'\fB\-d, \-\-decode\fP\X'tty: link'
decode data
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc-i'\fB\-i, \-\-ignore\-garbage\fP\X'tty: link'
when decoding, ignore non\-alphabet characters
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc-w'\fB\-w, \-\-wrap=\,COLS\fP\X'tty: link'\/\fR
wrap encoded lines after COLS character (default 76).
Use 0 to disable line wrapping
.TP
\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#basenc--z85'\fB\-\-z85\fP\X'tty: link'
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
\X'tty: link https://www.gnu.org/software/coreutils/basenc#basenc--help'\fB\-\-help\fP\X'tty: link'
display this help and exit
.TP
\X'tty: link https://www.gnu.org/software/coreutils/basenc#basenc--version'\fB\-\-version\fP\X'tty: link'
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"
Report bugs to: bug\-coreutils@gnu.org
.br
GNU coreutils home page: <https://www.gnu.org/software/coreutils/>
.br
General help using GNU software: <https://www.gnu.org/gethelp/>
.br
Report any translation bugs to <https://translationproject.org/team/>
.SH COPYRIGHT
Copyright \(co 2026 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