summaryrefslogtreecommitdiff
path: root/support/arara/doc/arara.1
diff options
context:
space:
mode:
Diffstat (limited to 'support/arara/doc/arara.1')
-rw-r--r--support/arara/doc/arara.147
1 files changed, 47 insertions, 0 deletions
diff --git a/support/arara/doc/arara.1 b/support/arara/doc/arara.1
new file mode 100644
index 0000000000..3b78f43003
--- /dev/null
+++ b/support/arara/doc/arara.1
@@ -0,0 +1,47 @@
+.TH ARARA 1 "26 February 2021" "v6.0.0"
+.SH NAME
+arara \- a TeX automation tool based on rules and directives.
+.SH SYNOPSIS
+.B arara
+.RI [ options ]
+.IR documents ...
+.SH DESCRIPTION
+\fBarara\fP is a TeX automation tool based on rules and directives. It gives
+you a way to enhance your TeX experience. The tool is an effort to provide a
+concise way to automate the daily TeX workflow for users and also package
+writers. Users might write their own rules when the provided ones do not suffice.
+.PP
+arara takes a list of documents as input. They will be processed according
+to their directives. Options apply to the execution of all documents.
+.SH OPTIONS
+.IP \fB--log\fP
+Generate a log output.
+.IP \fB--verbose\fP / \fB--silent\fP
+Print or suppress command output.
+.IP \fB--dry-run\fP
+Go through all the motions of running a command but with no actual calls.
+.IP \fB--safe-run\fP
+Run in safe mode and disable potentially harmful features.
+.IP \fB--header\fP
+Extract directives only in the file header.
+.IP \fB--preamble\fP name
+Set the file preamble as named based on the configuration file.
+.IP \fB--timeout\fP milliseconds
+Sets an execution timeout for spawned processes.
+.IP \fB--language\fP code
+Set the localization to the language specified by code.
+.IP \fB--max-loops\fP number
+Set the number > 0 of loops for looping directives.
+.IP \fB--working-directory\fP path
+Set the working directory for the whole execution.
+.IP \fB--call-property\fP value
+Pass a property as \fCkey=value\fP parameter into the application
+to be used within the session.
+.IP \fB--version\fP
+Show the version and exit.
+.IP \fB--help\fP
+Show a help message and exit.
+.SH BUGS
+Issue tracker at
+.UR https://gitlab.com/islandoftex/arara/-/issues
+.UE .