1
0
forked from bonsai/harakit

docs, src: updates usage text for utilities

This commit is contained in:
Emma Tebibyte 2024-06-29 05:18:20 -06:00
parent 0fc9a6b533
commit e341c38cd6
Signed by untrusted user: emma
GPG Key ID: 06FA419A1698C270
16 changed files with 33 additions and 51 deletions

View File

@ -11,25 +11,17 @@ dj \(en disk jockey
.SH SYNOPSIS .SH SYNOPSIS
dj dj
.RB ( -AdHnq ) .RB [ -AdHnq ]
.RB ( -a .RB [ -a\ byte ]
.RB [ byte ]) .RB [ -c\ count ]
.RB ( -c
.RB [ count ])
.RB ( -i .RB [ -i\ input_file ]
[\fBinput file\fP]) .RB [ -b\ input_block_size ]
.RB ( -b .RB [ -s\ input_offset ]
[\fBinput block size\fP])
.RB ( -s
[\fBinput offset\fP])
.RB ( -o .RB [ -o\ output_file ]
[\fBoutput file\fP]) .RB [ -B\ output_block_size ]
.RB ( -B .RB [ -S\ output_offset ]
[\fBoutput block size\fP])
.RB ( -S
[\fBoutput offset\fP])
.\" .\"
.SH DESCRIPTION .SH DESCRIPTION

View File

@ -11,9 +11,7 @@ intcmp \(en compare integers
.SH SYNOPSIS .SH SYNOPSIS
intcmp intcmp
.RB ( -egl ) .RB [ -egl ]\ integer\ integer...
.RB [ integer ]
.RB [ integer... ]
.SH DESCRIPTION .SH DESCRIPTION
Compare integers to each other. Compare integers to each other.
.\" .\"

View File

@ -10,11 +10,9 @@ mm \(en middleman
.SH SYNOPSIS .SH SYNOPSIS
mm mm
.RB ( -aenu ) .RB [ -aenu ]
.RB ( -i .RB [ -i\ input ]
.RB [ input ]) .RB [ -o\ output ]
.RB ( -o
.RB [ output ])
.\" .\"
.SH DESCRIPTION .SH DESCRIPTION

View File

@ -11,7 +11,7 @@ npc \(en show non-printing characters
.SH SYNOPSIS .SH SYNOPSIS
npc npc
.RB ( -et ) .RB [ -et ]
.\" .\"
.SH DESCRIPTION .SH DESCRIPTION

View File

@ -10,8 +10,8 @@ scrut \(en scrutinize file properties
.SH SYNOPSIS .SH SYNOPSIS
scrut scrut
.RB ( -LSbcdefgkprsuwx ) .RB [ -LSbcdefgkprsuwx ]
.RB [ file... ] .B file...
.\" .\"
.SH DESCRIPTION .SH DESCRIPTION

View File

@ -11,8 +11,7 @@ str \(en test string arguments
.SH SYNOPSIS .SH SYNOPSIS
str str
.RB [ type ] .B type string...
.RB [ string... ]
.\" .\"
.SH DESCRIPTION .SH DESCRIPTION

View File

@ -11,8 +11,7 @@ strcmp \(en compare strings
.SH SYNOPSIS .SH SYNOPSIS
strcmp strcmp
.RM [ string ] .B string string...
.RB [ strings... ]
.\" .\"
.SH DESCRIPTION .SH DESCRIPTION

View File

@ -11,11 +11,8 @@ swab \(en swap bytes
.SH SYNOPSIS .SH SYNOPSIS
swab swab
.RB ( -f ) .RB [ -f ]
.RB ( -w .RB [ -w\ word_size ]
.R [
.B word size
.R ])
.\" .\"
.SH DESCRIPTION .SH DESCRIPTION
@ -26,10 +23,9 @@ Swap the latter and former halves of a block of bytes.
.IP \fB-f\fP .IP \fB-f\fP
Ignore SIGINT signal. Ignore SIGINT signal.
.IP \fB-w\fP .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
on which to operate. The default word size is 2. The word size must be to operate. The default word size is 2. The word size must be cleanly divisible
cleanly divisible by 2, otherwise the block of bytes being processed can\(cqt be by 2, otherwise the block of bytes being processed can\(cqt be halved.
halved.
.\" .\"
.SH EXAMPLES .SH EXAMPLES

View File

@ -313,9 +313,9 @@ parse(char *s){
static int static int
usage(void){ usage(void){
fprintf(stderr, "Usage: %s (-AdfHqQ) (-a [byte]) (-c [count])\n" fprintf(stderr, "Usage: %s [-AdfHqQ] [-a byte] [-c count]\n"
"\t(-i [input file]) (-b [input block size]) (-s [input offset])\n" "\t[-i input_file] [-b input_block_size] [-s input_offset]\n"
"\t(-o [output file]) (-B [output block size]) (-S [output offset])\n", "\t[-o output_file] [-B output_block_size] [-S output_offset]\n",
program_name); program_name);
return EX_USAGE; return EX_USAGE;

View File

@ -52,7 +52,7 @@ int main(int argc, char *argv[]){
if(optind + 2 /* ref cmp */ > argc){ if(optind + 2 /* ref cmp */ > argc){
usage: fprintf(stderr, usage: fprintf(stderr,
"Usage: %s (-eghl) [integer] [integer...]\n", "Usage: %s [-eghl] integer integer...\n",
argv[0] == NULL ? program_name : argv[0]); argv[0] == NULL ? program_name : argv[0]);
return EX_USAGE; return EX_USAGE;
} }

View File

@ -110,7 +110,7 @@ oserr(char *s, char *r){
* returns an exit status appropriate for a usage error. */ * returns an exit status appropriate for a usage error. */
int usage(char *s){ int usage(char *s){
fprintf(stderr, "Usage: %s (-aenu) (-i [input])... (-o [output])...\n", s); fprintf(stderr, "Usage: %s [-aenu] [-i input]... [-o output]...\n", s);
return EX_USAGE; return EX_USAGE;
} }

View File

@ -39,7 +39,7 @@ int main(int argc, char *argv[]){
} }
if(argc > optind){ if(argc > optind){
usage: fprintf(stderr, "Usage: %s (-eht)\n", argv[0]); usage: fprintf(stderr, "Usage: %s [-eht]\n", argv[0]);
return EX_USAGE; return EX_USAGE;
} }

View File

@ -66,7 +66,7 @@ int main(int argc, char *argv[]){
if(ops[i] == 'e') if(ops[i] == 'e')
continue; continue;
else if(ops[i] == 'h'){ else if(ops[i] == 'h'){
usage: fprintf(stderr, "Usage: %s (-%s) [file...]\n", usage: fprintf(stderr, "Usage: %s [-%s] file...\n",
argv[0] == NULL argv[0] == NULL
? program_name ? program_name
: argv[0], : argv[0],

View File

@ -56,7 +56,7 @@ int main(int argc, char *argv[]){
goto pass; goto pass;
} }
fprintf(stderr, "Usage: %s [type] [string...]\n", fprintf(stderr, "Usage: %s type string...\n",
argv[0] == NULL ? program_name : argv[0]); argv[0] == NULL ? program_name : argv[0]);
return EX_USAGE; return EX_USAGE;

View File

@ -8,7 +8,7 @@ int main(int argc, char *argv[]){
int i; int i;
if(argc < 3){ if(argc < 3){
fprintf(stderr, "Usage: %s [string] [string...]\n", fprintf(stderr, "Usage: %s string string...\n",
argv[0] == NULL ? program_name : argv[0]); argv[0] == NULL ? program_name : argv[0]);
return EX_USAGE; return EX_USAGE;
} }

View File

@ -35,7 +35,7 @@ fn oserr(s: &str, e: Error) -> ExitCode {
} }
fn usage(s: &str) -> ExitCode { fn usage(s: &str) -> ExitCode {
eprintln!("Usage: {} (-f) (-w [wordsize])", s); eprintln!("Usage: {} [-f] [-w word_size]", s);
ExitCode::from(EX_USAGE as u8) ExitCode::from(EX_USAGE as u8)
} }