aboutsummaryrefslogtreecommitdiff
path: root/rpt.1.in
diff options
context:
space:
mode:
authorTristan Riehs <tristan.riehs@bordeaux-inp.fr>2024-02-03 17:54:02 +0100
committerTristan Riehs <tristan.riehs@bordeaux-inp.fr>2024-02-03 17:54:02 +0100
commitfc4f1875fe57c39bf122cfb43a30893fef58c157 (patch)
tree7a84c5bcacec39b2bb7d6c8250a23da780009ef6 /rpt.1.in
parent18a47f8b4bf99366beea3b9486566ebe26f7de5d (diff)
reapeat now built using the GNU Autotools
Diffstat (limited to 'rpt.1.in')
-rw-r--r--rpt.1.in117
1 files changed, 117 insertions, 0 deletions
diff --git a/rpt.1.in b/rpt.1.in
new file mode 100644
index 0000000..b7c70ea
--- /dev/null
+++ b/rpt.1.in
@@ -0,0 +1,117 @@
+.\" Written by Tristan Riehs.
+.\" This file is part of repeat and is licensed under the MIT License.
+.TH repeat @VERSION@ 2023-09-27
+
+.SH NAME
+repeat \- repeat a shell command
+
+.SH SYNOPSIS
+.B rpt
+[
+.B \-n
+|
+.B \-\-count
+.I COUNT
+] [
+.B \-f
+|
+.B \-\-force
+]
+.I COMMAND
+
+.B rpt
+[
+.B \-h
+|
+.B \-\-help
+]
+
+.B rpt
+[
+.B \-V
+|
+.B \-\-version
+]
+
+.SH DESCRIPTION
+.B rpt
+allows you to easily repeat a command a certain number of times.
+The command is repeated sequentially.
+If stdin is not empty,
+it is given to
+.IR COMMAND .
+
+.SH OPTIONS
+.BR \-h ,
+.B \-\-help
+.RS
+Display help.
+.RE
+
+.BR \-V ,
+.B \-\-version
+.RS
+Display version.
+.RE
+
+.BR \-n ,
+.B \-\-count
+.I COUNT
+.RS
+Repeat
+.I COMMAND COUNT
+times.
+If this flag is not given,
+.I COMMAND
+is invoked once.
+.RE
+
+.BR \-f ,
+.B \-\-force
+.RS
+By default,
+.B rpt
+stops whenever
+.I COMMAND
+fails.
+If the
+.B force
+flag is set,
+.B rpt
+ignores errors.
+
+.SH "EXIT STATUS"
+When a subprocess exit abnormally and the
+.B force
+flag is not given,
+.B rpt
+exits with the same status as the subprocess.
+
+1. Invalid option.
+
+2. Error while reading
+.IR COUNT .
+This includes the case where the
+.B count
+flag is given,
+but
+.I COUNT
+is missing.
+
+3.
+.I COMMAND
+not provided.
+
+4. Other error.
+
+.SH FILES
+None.
+
+.SH "SEE ALSO"
+.BR seq (1)
+.BR test (1)
+
+.SH BUGS
+
+.SH AUTHOR
+Tristan Riehs <tristan.riehs@bordeaux-inp.fr>