harakit/docs/mm.1

70 lines
1.8 KiB
Groff
Raw Normal View History

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