harakit/docs/mm.1

91 lines
1.7 KiB
Groff
Raw Normal View History

2024-02-17 23:43:22 -07:00
.\" Copyright (c) 2024 DTB <trinity@trinity.moe>
.\"
.\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
.\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
.TH mm 1
.SH NAME
mm \(en middleman
.SH SYNOPSIS
mm
.RB ( -aenu )
.RB ( -i
.RB [ input ])
.RB ( -o
.RB [ output ])
.SH DESCRIPTION
2024-03-26 18:44:05 -06:00
Catenate input files and write them to the start of each output file or stream.
2024-02-17 23:43:22 -07:00
.SH OPTIONS
.B -a
2024-03-26 18:44:05 -06:00
.RS
2024-03-27 00:14:34 -06:00
Opens outputs for appending rather than updating.
2024-03-26 18:44:05 -06:00
.RE
.B -e
.RS
2024-03-27 00:14:34 -06:00
Use the standard error as an output.
2024-03-26 18:44:05 -06:00
.RE
2024-02-17 23:43:22 -07:00
.B -i
2024-03-26 18:44:05 -06:00
.RS
Opens a path as an input. Without any inputs specified mm will use the
standard input.
.RE
2024-02-17 23:43:22 -07:00
.B -o
2024-03-26 18:44:05 -06:00
.RS
Opens a path as an output. Without any outputs specified mm will use the
standard output.
.RE
2024-02-17 23:43:22 -07:00
.B -u
2024-03-26 18:44:05 -06:00
.RS
Ensures neither input or output will be buffered.
.RE
2024-02-17 23:43:22 -07:00
.B -n
2024-03-26 18:44:05 -06:00
.RS
Causes SIGINT signals to be ignored.
.RE
2024-02-17 23:43:22 -07:00
2024-03-27 00:14:34 -06:00
.SH STANDARD INPUT
The standard input shall be used as an input if one or more of the input files
is “-”.
2024-02-17 23:43:22 -07:00
.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.
2024-03-26 18:44:05 -06:00
When an error is encountered, diagnostic message is printed and the program
exits with the appropriate sysexits.h(3) status.
2024-02-17 23:43:22 -07:00
2024-03-27 00:14:34 -06:00
.SH CAVEATS
2024-02-17 23:43:22 -07:00
2024-03-27 00:14:34 -06:00
Existing files are not truncated on ouput and are instead overwritten.
2024-02-17 23:43:22 -07:00
.SH RATIONALE
2024-03-27 00:14:34 -06:00
The cat(1p) and tee(1p) programs specified in POSIX together provide nearly
equivalent functionality. The separation of the two sets of functionality into
separate APIs seemed unncessary.
2024-02-17 23:43:22 -07:00
.SH COPYRIGHT
2024-02-22 19:14:38 -07:00
Copyright (c) 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
2024-02-17 23:43:22 -07:00
<https://gnu.org/licenses/agpl.html>.
.SH SEE ALSO
cat(1p), dd(1), dj(1), tee(1p)