blob: d733b7d1c47274f8b7e1c3fdfe7017f3c2153daf (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
.TH ARARA 1 "06 May 2024" "v7.1.5"
.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--whole-file\fP
Extract directives in the file, not only in the 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--generate-completion\fP shell
Generate a completion script for arara.
.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 .
|
