aboutsummaryrefslogtreecommitdiff
path: root/man/od.1
diff options
context:
space:
mode:
authorSoccera1 <[email protected]>2026-07-28 16:08:14 +1000
committerSoccera1 <[email protected]>2026-07-28 16:08:48 +1000
commit9846f087eb28bf11df740675ef487657ded39b69 (patch)
treee91dbd19b524f9432da6bcb86b1fc193e0d02e26 /man/od.1
parent7fa396c9ef22b32a0b05e94aaa0266dd3e7515f8 (diff)
parent6a2f098e72e71437154ec00506e8e736aa8e1026 (diff)
downloadbnu-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/od.1')
-rw-r--r--man/od.1177
1 files changed, 177 insertions, 0 deletions
diff --git a/man/od.1 b/man/od.1
new file mode 100644
index 0000000..807ff1e
--- /dev/null
+++ b/man/od.1
@@ -0,0 +1,177 @@
+.\" Adapted for BNU from the GNU Coreutils 9.11 manual page; see doc/README.md.
+.TH OD "1" "2026-07-28" "BNU 9.11" "BNU Commands"
+.SH NAME
+od \- dump files in octal and other formats
+.SH SYNOPSIS
+.B od
+[\fI\,OPTION\/\fR]... [\fI\,FILE\/\fR]...
+.br
+.B od
+[\fI\,-abcdfilosx\/\fR]... [\fI\,FILE\/\fR] [[\fI\,+\/\fR]\fI\,OFFSET\/\fR[\fI\,.\/\fR][\fI\,b\/\fR]]
+.br
+.B od
+\fI\,--traditional \/\fR[\fI\,OPTION\/\fR]... [\fI\,FILE\/\fR] [[\fI\,+\/\fR]\fI\,OFFSET\/\fR[\fI\,.\/\fR][\fI\,b\/\fR] [\fI\,+\/\fR][\fI\,LABEL\/\fR][\fI\,.\/\fR][\fI\,b\/\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
+Write an unambiguous representation, octal bytes by default,
+of FILE to standard output. With more than one FILE argument,
+concatenate them in the listed order to form the input.
+.PP
+With no FILE, or when FILE is \-, read standard input.
+.PP
+If first and second call formats both apply, the second format is assumed
+if the last operand begins with + or (if there are 2 operands) a digit.
+An OFFSET operand means \fB\-j\fR OFFSET. LABEL is the pseudo\-address
+at first byte printed, incremented when dump is progressing.
+For OFFSET and LABEL, a 0x or 0X prefix indicates hexadecimal;
+suffixes may be . for octal and b for multiply by 512.
+.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#od-A'\fB\-A, \-\-address\-radix=\,RADIX\fP\X'tty: link'\/\fR
+output format for file offsets;
+RADIX is one of [doxn], for Decimal, Octal, Hex or None
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od--endian'\fB\-\-endian={big|little}\fP\X'tty: link'
+swap input bytes according the specified order
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od-j'\fB\-j, \-\-skip\-bytes=\,BYTES\fP\X'tty: link'\/\fR
+skip BYTES input bytes first
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od-N'\fB\-N, \-\-read\-bytes=\,BYTES\fP\X'tty: link'\/\fR
+limit dump to BYTES input bytes
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od-S'\fB\-S BYTES, \-\-strings[=\,BYTES]\fP\X'tty: link'\/\fR
+show only NUL terminated strings
+of at least BYTES (default 3) printable characters
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od-t'\fB\-t, \-\-format=\,TYPE\fP\X'tty: link'\/\fR
+select output format or formats
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od-v'\fB\-v, \-\-output\-duplicates\fP\X'tty: link'
+do not use * to mark line suppression
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od-w'\fB\-w[BYTES], \-\-width[=\,BYTES]\fP\X'tty: link'\/\fR
+output BYTES bytes per output line;
+32 is implied when BYTES is not specified
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od--traditional'\fB\-\-traditional\fP\X'tty: link'
+accept arguments in third form above
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/od#od--help'\fB\-\-help\fP\X'tty: link'
+display this help and exit
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/od#od--version'\fB\-\-version\fP\X'tty: link'
+output version information and exit
+.SS "Traditional format specifications may be intermixed; they accumulate:"
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od-a'\fB\-a\fP\X'tty: link'
+same as \fB\-t\fR a, select named characters, ignoring high\-order bit
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od-b'\fB\-b\fP\X'tty: link'
+same as \fB\-t\fR o1, select octal bytes
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od-c'\fB\-c\fP\X'tty: link'
+same as \fB\-t\fR c, select printable characters or backslash escapes
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od-d'\fB\-d\fP\X'tty: link'
+same as \fB\-t\fR u2, select unsigned decimal 2\-byte units
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od-f'\fB\-f\fP\X'tty: link'
+same as \fB\-t\fR fF, select floats
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od-i'\fB\-i\fP\X'tty: link'
+same as \fB\-t\fR dI, select decimal ints
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od-l'\fB\-l\fP\X'tty: link'
+same as \fB\-t\fR dL, select decimal longs
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od-o'\fB\-o\fP\X'tty: link'
+same as \fB\-t\fR o2, select octal 2\-byte units
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od-s'\fB\-s\fP\X'tty: link'
+same as \fB\-t\fR d2, select decimal 2\-byte units
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#od-x'\fB\-x\fP\X'tty: link'
+same as \fB\-t\fR x2, select hexadecimal 2\-byte units
+.SS "TYPE is made up of one or more of these specifications:"
+.TP
+a
+named character, ignoring high\-order bit
+.TP
+c
+printable character or backslash escape
+.TP
+d[SIZE]
+signed decimal, SIZE bytes per integer
+.TP
+f[SIZE]
+floating point, SIZE bytes per float
+.TP
+o[SIZE]
+octal, SIZE bytes per integer
+.TP
+u[SIZE]
+unsigned decimal, SIZE bytes per integer
+.TP
+x[SIZE]
+hexadecimal, SIZE bytes per integer
+.PP
+SIZE is a number. For TYPE in [doux], SIZE may also be C for
+sizeof(char), S for sizeof(short), I for sizeof(int) or L for
+sizeof(long). If TYPE is f, SIZE may also be B for Brain 16 bit,
+H for Half precision float, F for sizeof(float), D for sizeof(double),
+or L for sizeof(long double).
+.PP
+Adding a z suffix to any type displays printable characters at the end of
+each output line.
+.SS "BYTES is hex with 0x or 0X prefix, and may have a multiplier suffix:"
+.TP
+b
+512
+.TP
+KB
+1000
+.TP
+K
+1024
+.TP
+MB
+1000*1000
+.TP
+M
+1024*1024
+.PP
+and so on for G, T, P, E, Z, Y, R, Q.
+Binary prefixes can be used, too: KiB=K, MiB=M, and so on.
+.SH EXAMPLES
+.TP
+.B od -A x -t x1z -v
+Display hexdump format output
+.TP
+.B od -A o -t oS -w16
+The default output format used by od
+.SH AUTHORS
+Upstream GNU Coreutils documentation authors:
+Written by Jim Meyering.
+.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/od>
+.br
+BNU documentation is available locally via: info \(aq(bnu) od invocation\(aq