Debian Codegraph @

upstream/debian-trixie/man1/basenc.1

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