diff options
| author | Soccera1 <[email protected]> | 2026-07-28 16:08:14 +1000 |
|---|---|---|
| committer | Soccera1 <[email protected]> | 2026-07-28 16:08:48 +1000 |
| commit | 9846f087eb28bf11df740675ef487657ded39b69 (patch) | |
| tree | e91dbd19b524f9432da6bcb86b1fc193e0d02e26 /man/basenc.1 | |
| parent | 7fa396c9ef22b32a0b05e94aaa0266dd3e7515f8 (diff) | |
| parent | 6a2f098e72e71437154ec00506e8e736aa8e1026 (diff) | |
| download | bnu-refactor/single-call-commands.tar.gz bnu-refactor/single-call-commands.zip | |
Merge branch 'master' into refactor/single-call-commandsrefactor/single-call-commands
# Conflicts:
# README.md
Diffstat (limited to 'man/basenc.1')
| -rw-r--r-- | man/basenc.1 | 116 |
1 files changed, 116 insertions, 0 deletions
diff --git a/man/basenc.1 b/man/basenc.1 new file mode 100644 index 0000000..a4929e9 --- /dev/null +++ b/man/basenc.1 @@ -0,0 +1,116 @@ +.\" Adapted for BNU from the GNU Coreutils 9.11 manual page; see doc/README.md. +.TH BASENC "1" "2026-07-28" "BNU 9.11" "BNU Commands" +.SH NAME +basenc \- Encode/decode data and print to standard output +.SH SYNOPSIS +.B basenc +[\fI\,OPTION\/\fR]... [\fI\,FILE\/\fR] +.SH DESCRIPTION +.\" This page is derived from GNU Coreutils documentation. +This page documents BNU, an independent Bun implementation compatible with +GNU Coreutils 9.11. +.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 +.RE +.fi +.SH AUTHORS +Upstream GNU Coreutils documentation authors: +Written by Simon Josefsson and Assaf Gordon. +.br +Adapted for BNU; the BNU implementation is independent. +.SH "REPORTING BUGS" +Report BNU bugs at <https://github.com/Soccera1/bnu/issues>. +.br +For upstream GNU Coreutils, see <https://www.gnu.org/software/coreutils/>. +.SH COPYRIGHT +Copyright \(co 2026 Free Software Foundation, Inc. +.br +This manual page was adapted for BNU in 2026. +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" +Upstream documentation <https://www.gnu.org/software/coreutils/basenc> +.br +BNU documentation is available locally via: info \(aq(bnu) basenc invocation\(aq |
