bonsai
/
coreutils
5
4
Fork 2
Code Issues 36 Pull Requests 4 Projects 1 Releases 9 Activity

mm.1: updated man page

This commit is contained in:
Emma Tebibyte 2024-03-26 18:44:05 -06:00
parent a6fd1108c6
commit cf76fa94e6
Signed by: emma
GPG Key ID: 06FA419A1698C270
1 changed files with 35 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
docs/mm.1
View File

@ -20,51 +20,60 @@ mm
.SH DESCRIPTION
Mm catenates input files and writes them to the start of each output file.
Catenate input files and write them to the start of each output file or stream.
.SH OPTIONS
Mm, upon receiving the
.B -a
option, will open subsequent outputs for appending rather than updating.
.PP
The
.B -i
option opens a path as an input. Without any inputs specified mm will use
standard input. Standard input itself can be specified by giving the path '-'.
.PP
The
.B -o
option opens a path as an output. Without any outputs specified mm will use
standard output. Standard output itself can be specified by giving the
path '-'. Standard error itself can be specified with the
.RS
Opens subsequent outputs for appending rather than updating.
.RE
.B -e
option.
.PP
The
.RS
Set the output to the standard error.
.RE
.B -i
.RS
Opens a path as an input. Without any inputs specified mm will use the
standard input.
.RE
.B -o
.RS
Opens a path as an output. Without any outputs specified mm will use the
standard output.
.RE
.B -u
option ensures neither input or output will be buffered.
.PP
The
.RS
Ensures neither input or output will be buffered.
.RE
.B -n
option tells mm to ignore SIGINT signals.
.RS
Causes SIGINT signals to be ignored.
.RE
.SH DIAGNOSTICS
If an output can no longer be written mm prints a diagnostic message, ceases
writing to that particular output, and if there are more outputs specified,
continues, eventually exiting unsuccessfully.
.PP
On error mm prints a diagnostic message and exits with the appropriate
sysexits.h(3) status.
When an error is encountered, diagnostic message is printed and the program
exits with the appropriate sysexits.h(3) status.
.SH BUGS
Mm does not truncate existing files, which may lead to unexpected results.
Existing files are not truncated, which may lead to unexpected results.
.SH RATIONALE
Mm was modeled after the cat and tee utilities specified in POSIX.
The cat(1p) and tee(1p) programs specified in POSIX provide equivalent
functionality. The separation of the two sets of functionality into separate
APIs seemed unncessary.
.SH COPYRIGHT