trinity/overgrown
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

swab.1: fixes formatting

Browse Source
This commit is contained in:
Emma Tebibyte 2024-06-03 23:47:14 -06:00
parent beff2d98c6
commit fec61fee1b
Signed by untrusted user: emma
GPG Key ID: 06FA419A1698C270
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/swab.1
View File

@ -23,9 +23,9 @@ Swap the latter and former halves of a block of bytes.
.\" .\"
.SH OPTIONS .SH OPTIONS
.IP -f .IP \fB-f\fP
Ignore system call interruptions. Ignore system call interruptions.
.IP -w .IP \fB-w\fP
Configures the word size; that is, the size in bytes of the block size Configures the word size; that is, the size in bytes of the block size
on which to operate. By default the word size is 2. The word size must be on which to operate. By default the word size is 2. The word size must be
cleanly divisible by 2, otherwise the block of bytes being processed can't be cleanly divisible by 2, otherwise the block of bytes being processed can't be
@ -33,7 +33,9 @@ halved.
.\" .\"
.SH EXAMPLES .SH EXAMPLES
The following sh(1p) line: The following
.Br sh (1p)
line:
.RS .RS
.R printf 'hello world!\n' | swab .R printf 'hello world!\n' | swab
@ -48,12 +50,16 @@ Produces the following output:
.SH DIAGNOSTICS .SH DIAGNOSTICS
In the event of an error, a debug message will be printed and the program will In the event of an error, a debug message will be printed and the program will
exit with the appropriate sysexits.h(3) error code. exit with the appropriate
.BR sysexits.h (3)
error code.
.\" .\"
.SH RATIONALE .SH RATIONALE
This program was modeled and named after the conv=swab functionality specified This program was modeled and named after the conv=swab functionality specified
in the dd(1p) utility. It additionally allows the word size to be configured. in the
.BR dd (1p)
utility. It additionally allows the word size to be configured.
This functionality is useful for fixing the endianness of binary files produced This functionality is useful for fixing the endianness of binary files produced
on other machines. on other machines.