summaryrefslogtreecommitdiff
path: root/support/arara/doc/chapters/deploying.tex
diff options
context:
space:
mode:
Diffstat (limited to 'support/arara/doc/chapters/deploying.tex')
-rw-r--r--support/arara/doc/chapters/deploying.tex96
1 files changed, 46 insertions, 50 deletions
diff --git a/support/arara/doc/chapters/deploying.tex b/support/arara/doc/chapters/deploying.tex
index 533b883ee2..2dfc68141c 100644
--- a/support/arara/doc/chapters/deploying.tex
+++ b/support/arara/doc/chapters/deploying.tex
@@ -4,14 +4,10 @@
As previously mentioned, \arara\ runs on top of a Java virtual machine, available on all major operating systems -- in some cases, you might need to install the proper virtual machine. This chapter provides detailed instructions on how to properly deploy the tool in your computer from either the official package available in our project repository or a personal build generated from source (as seen in Section~\ref{sec:compilingthetool}, on page~\pageref{sec:compilingthetool}).
-\begin{messagebox}{No more installers}{araracolour}{\icok}{white}
-Be mindful that, from version 4.0 on, the team decided to not release cross-platform installers any more. Our tool is available off the shelf on all major \TeX\ distributions, including \TeX\ Live and MiK\TeX, which makes manual installation unnecessary given the significant coverage of such distributions. Chances are you already have \arara\ in your system!
-\end{messagebox}
-
\section{Directory structure}
\label{sec:directorystructure}
-From the early development stages, our tool employs a very straightforward directory structure. In short, we provide the \abox[araracolour]{ARARA\_HOME} alias to the directory path in which the \rbox[araracolour]{arara.jar} Java archive file is located. This particular file is the heart and soul of our tool and dictates the default rule search path, which is a special directory named \abox[araracolour]{rules/} available from the same level. This directory contains all rules specified in the \gls{YAML} format, as seen in Section~\ref{sec:rule}, on page~\pageref{sec:rule}. The structure overview is presented as follows.
+From the early development stages, our tool employs a very straightforward directory structure. In short, we provide the \abox[araracolour]{ARARA\_HOME} alias to the directory path in which the \rbox[araracolour]{arara.jar} Java archive file is located. This particular file is the heart and soul of our tool and dictates the default rule search path, which is a special directory named \abox[araracolour]{rules/} available from the same level. This directory contains all rules specified in the YAML format, as seen in Section~\ref{sec:rule}, on page~\pageref{sec:rule}. The structure overview is presented as follows.
\vspace{1em}
@@ -36,15 +32,15 @@ forked edges,
\vspace{1.4em}
-Provided that this specific directory structure is honoured, the tool is ready for use off the shelf. In fact, the official \arara\ package available in the \href{https://github.com/cereda/arara/releases}{release section} of our project repository, as well as the \href{https://bintray.com/cereda/arara}{Bintray} software distribution service, exactly mirrors this structure. Once the package is properly downloaded, we simply need to extract it into a proper \abox[araracolour]{ARARA\_HOME} location.
+Provided that this specific directory structure is honoured, the tool is ready for use off the shelf. In fact, the official \arara\ package available in the \href{https://gitlab.com/islandoftex/arara/-/releases}{release section} of our project repository. Once the package is properly downloaded, we simply need to extract it into a proper \abox[araracolour]{ARARA\_HOME} location.
\section{Defining a location}
\label{sec:definingalocation}
-First and foremost, we need to obtain \rbox{arara-4.0.zip} from either our project repository at GitHub or at the Bintray service mirror. As the name indicates, this is a compressed file format, so we need to extract it into a proper location. Run the following command in the terminal:
+First and foremost, we need to obtain \rbox{arara-5.0.zip} from either our project repository at GitLab. As the name indicates, this is a compressed file format, so we need to extract it into a proper location. Run the following command in the terminal:
\begin{codebox}{Terminal}{teal}{\icnote}{white}
-$ unzip arara-4.0.zip
+$ unzip arara-5.0.zip
\end{codebox}
As a result of the previous command, we obtained a directory named \abox[araracolour]{arara} with the exact structure presented in Section~\ref{sec:directorystructure} in our working directory. Now we need to decide where \arara\ should reside in our system. For example, I usually deploy my tools inside the \abox[araracolour]{/opt/paulo} path, so I need to run the following command in the terminal (please note that my personal directory already has the proper permissions, so I do not need superuser privileges):
@@ -96,31 +92,31 @@ If the tool was built from source (as indicated in Section~\ref{sec:compilingthe
\begin{codebox}{Terminal}{teal}{\icnote}{white}
$ java -jar /opt/paulo/arara/arara.jar
- __ _ _ __ __ _ _ __ __ _
+ __ _ _ __ __ _ _ __ __ _
/ _` | '__/ _` | '__/ _` |
| (_| | | | (_| | | | (_| |
\__,_|_| \__,_|_| \__,_|
-arara 4.0 (revision 1)
-Copyright (c) 2012-2018, Paulo Roberto Massa Cereda
-All rights reserved
-
-usage: arara [file [--dry-run] [--log] [--verbose | --silent]
- [--timeout N] [--max-loops N] [--language L]
- [ --preamble P ] [--header] | --help | --version]
- -h,--help print the help message
- -H,--header extract directives only in the file header
- -l,--log generate a log output
- -L,--language <code> set the application language
- -m,--max-loops <number> set the maximum number of loops
- -n,--dry-run go through all the motions of running a
- command, but with no actual calls
- -p,--preamble <name> set the file preamble based on the
- configuration file
- -s,--silent hide the command output
- -t,--timeout <number> set the execution timeout (in milliseconds)
- -V,--version print the application version
- -v,--verbose print the command output
+Usage: arara [OPTIONS] [file]...
+
+Options:
+ -l, --log Generate a log output
+ -v, --verbose / -s, --silent Print the command output
+ -n, --dry-run Go through all the motions of running a
+ command, but with no actual calls
+ -H, --header Extract directives only in the file header
+ -t, --timeout INT Set the execution timeout (in milliseconds)
+ -L, --language TEXT Set the application language
+ -m, --max-loops INT Set the maximum number of loops (> 0)
+ -p, --preamble TEXT Set the file preamble based on the
+ configuration file
+ -d, --working-directory DIRECTORY
+ Set the working directory for all tools
+ -V, --version Show the version and exit
+ -h, --help Show this message and exit
+
+Arguments:
+ file The file(s) to evaluate and process
\end{codebox}
Please observe that, provided that the underlying operating system has an appropriate Java virtual machine installed, \arara\ can be used as a portable, standalone application. Portable applications can be stored on any data storage device, including external devices such as USB drives and floppy disks.
@@ -186,31 +182,31 @@ Regardless of the adopted approach, there should be an \rbox{arara} wrapper avai
\begin{codebox}{Terminal}{teal}{\icnote}{white}
$ arara
- __ _ _ __ __ _ _ __ __ _
+ __ _ _ __ __ _ _ __ __ _
/ _` | '__/ _` | '__/ _` |
| (_| | | | (_| | | | (_| |
\__,_|_| \__,_|_| \__,_|
-arara 4.0 (revision 1)
-Copyright (c) 2012-2018, Paulo Roberto Massa Cereda
-All rights reserved
-
-usage: arara [file [--dry-run] [--log] [--verbose | --silent]
- [--timeout N] [--max-loops N] [--language L]
- [ --preamble P ] [--header] | --help | --version]
- -h,--help print the help message
- -H,--header extract directives only in the file header
- -l,--log generate a log output
- -L,--language <code> set the application language
- -m,--max-loops <number> set the maximum number of loops
- -n,--dry-run go through all the motions of running a
- command, but with no actual calls
- -p,--preamble <name> set the file preamble based on the
- configuration file
- -s,--silent hide the command output
- -t,--timeout <number> set the execution timeout (in milliseconds)
- -V,--version print the application version
- -v,--verbose print the command output
+Usage: arara [OPTIONS] [file]...
+
+Options:
+ -l, --log Generate a log output
+ -v, --verbose / -s, --silent Print the command output
+ -n, --dry-run Go through all the motions of running a
+ command, but with no actual calls
+ -H, --header Extract directives only in the file header
+ -t, --timeout INT Set the execution timeout (in milliseconds)
+ -L, --language TEXT Set the application language
+ -m, --max-loops INT Set the maximum number of loops (> 0)
+ -p, --preamble TEXT Set the file preamble based on the
+ configuration file
+ -d, --working-directory DIRECTORY
+ Set the working directory for all tools
+ -V, --version Show the version and exit
+ -h, --help Show this message and exit
+
+Arguments:
+ file The file(s) to evaluate and process
\end{codebox}
It is important to observe that the wrapper initiative presented in this section might cause a potential name clash with existing \TeX\ Live or MiK\TeX\ binaries and symbolic links. In this particular scenario, make sure to inspect the command location as a means to ensure a correct execution. To this end, run the following command in the terminal: