summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/latexmk/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/latexmk/INSTALL')
-rw-r--r--Master/texmf-dist/doc/support/latexmk/INSTALL91
1 files changed, 67 insertions, 24 deletions
diff --git a/Master/texmf-dist/doc/support/latexmk/INSTALL b/Master/texmf-dist/doc/support/latexmk/INSTALL
index 225e1c6e6b5..d351b7165cd 100644
--- a/Master/texmf-dist/doc/support/latexmk/INSTALL
+++ b/Master/texmf-dist/doc/support/latexmk/INSTALL
@@ -1,6 +1,6 @@
INSTALLING latexmk
==================
- (Version 4.00, 12 March 2008)
+ (Version 4.05, 11 April 2008)
John Collins
Physics Department
@@ -46,33 +46,51 @@ b. A working installation of TeX and LaTeX. (See http://www.ctan.org/ if
Installing on UNIX/LINUX
========================
+(Power users can modify these as appropriate.)
+
1. Make sure you have working installations of Perl and TeX/LaTeX.
2. Put the file latexmk.pl in a directory for executable files. For
example, for a system-wide installation, you could put it in
- /usr/local/bin.
+ /usr/local/bin. But if you are an ordinary user, you can put the
+ file somewhere where you have access.
3. Rename this file to latexmk.
4. Make sure latexmk is executable, e.g., by using chmod suitably.
+ [Special case, which you probably don't have to be concerned
+ with: You may also find it necessary to change the first line
+ of the script so that perl can be found to execute latexmk.
+ Currently the first line is #!/usr/bin/env perl, which uses
+ the program /usr/bin/env to find perl, provided only that the
+ perl executable can be found in the PATH for executables.
+ This insulates latexmk from the fact that the perl executable
+ has a very system dependent location. The program /usr/bin/env
+ is suppposed to be present on almost all modern UNIX/Linux
+ systems.]
5. (Optional) Copy the file latexmk.1 to an appropriate directory for man
pages, e.g., /usr/local/man/man1/.
-6. Check whether the commands used by latexmk for executing latex etc are
- correct. Normally the only one you have to worry about is $pscmd.
- This runs the command ps and is used in preview_continuous_mode to
- determine whether a previewer is already running. The format of the
- output of ps is highly system dependent. Latexmk should get it right
- under LINUX and Solaris. If latexmk does not get this or another
- command correct, put an override in a startup file.
+6. Check whether the commands used by latexmk for executing latex etc
+ are correct. The ones you have to worry about are those for
+ previewing files ($pdf_previewer, $ps_previewer, and
+ $dvi_previwer), and most importantly $pscmd, and its associated
+ variable $pid_position --- see below. The command $pscmd is the
+ least obvious: it runs the command ps and is used in
+ preview_continuous_mode to determine whether a previewer is
+ already running. The format of the output of ps is highly system
+ dependent. Latexmk should get it right under LINUX and Solaris.
+ If latexmk does not get this or another command correct, put an
+ override in a startup file.
a. For a system-wide installation, the correction should be in the
system startup file, which is any one of the files
/opt/local/share/latexmk/LatexMk,
/usr/local/share/latexmk/LatexMk,
/usr/local/lib/latexmk/LatexMk.
- (You get to choose which.)
+ (You get to choose which, but only one. If none of these
+ directories is appropriate you'll need to modify latexmk.pl.)
b. If you are installing latexmk as an ordinary user, the startup
file is the user startup file, which is the file .latexmkrc in
@@ -80,23 +98,43 @@ Installing on UNIX/LINUX
The startup files are written in perl, so possible overrides are like
- $latex = 'unusual_program_to_run_instead_of_normal_latex';
+ $latex = 'unusual_program_to_run_instead_of_normal_latex %O %S';
for changing the program to run latex, and
$pscmd = 'ps -aeg';
$pid_position = 1;
- for the ps command. Here, $pid_position = 1 indicates that the process
- ID number is in the first column of the output of the command ps.
+ for the ps command. Here, $pid_position = 1 indicates that the
+ process ID number is in the first column of the output of the
+ command ps. See the latexmk.pl file for some examples.
7. If you need any modifications on the commands for running previewers,
like gv, note that prefixing a command by start, as in
- $ps_previewer = 'start gv -watch';
+ $ps_previewer = 'start gv -watch %O %S';
ensures that the command is run detached, as is normally appropriate
- for a previewer.
+ for a previewer.
+
+ (In the examples above, there appear the strings %O and %S. See
+ the documenation for details. They are placeholders used when
+ latexmk constructs the command line. %O denotes any options
+ latexmk wants to add to the command invocation, and %S denotes the
+ source file.)
+
+8. You may also want to change the defaults on what kinds of output
+ file makes. By default latexmk makes dvi files, but not
+ postscript or pdf files. If you (or people on your system)
+ generally make pdf files using pdflatex, it would be a good idea
+ to put the following in an appropriate initialization file:
+
+ $pdf_mode = 1;
+ $postscript_mode = 0;
+ $dvi_mode = 0;
+
+ See step 6 for the locations of these files (under UNIX-like
+ systems). This change is likely to be particularly for Mac OS-X.
Installing on MS-Windows
@@ -153,11 +191,12 @@ Installing on MS-Windows
which is a pure ASCII text file, and latexmk.ps which is a postscript
file.
-6. Check whether perl is in the search path for executables. (E.g., from
- the MSDOS command-line prompt, try the command perl --version.) If
- perl is not in the search path, then modify the first line of
- latexmk.bat (which you installed at step 2) by replacing the command
- perl by the full path name for perl, e.g., C:\perl\bin\perl.exe.
+6. Check whether perl is in the search path for executables. (E.g.,
+ from the MS-Windows command-line prompt, try the command perl
+ --version.) If perl is not in the search path, then modify the
+ first line of latexmk.bat (which you installed at step 2) by
+ replacing the command perl by the full path name for perl, e.g.,
+ C:\perl\bin\perl.exe.
7. You may need to reboot, or at least logoff and log back in, if you
made any changes to the path at step 3. Test out the installation
@@ -199,12 +238,16 @@ Installing on MS-Windows
installation instructions for what to do. The only changes needed
from the UNIX instructions are:
- a. The system initialization file is C:\latexmk\LatexMk.
+ a. The system initialization file is C:\latexmk\LatexMk. (If
+ this is not suitable for some reason, you'll need to change
+ the latexmk.pl file where this filename appears.)
b. The user initialization file is .latexmkrc in the directory
specified by the environment variable HOME. If there is no HOME
- variable, then the file is in the root directory of the current
- drive.
+ variable, then the file is in the directory specified by the
+ environment variable USERPROFILE, which should have been set
+ by the MS-Windows operating system at login.
+
Other systems
@@ -265,7 +308,7 @@ Version 2 was modified by Evan McLean.
The current version is by John Collins (username collins at node
phys.psu.edu) -- other contact details at the top. It is copyright
-1998-2008 by John Collins, and the previous authors; see the copyright
+1998-2009 by John Collins, and the previous authors; see the copyright
notice in the latexmk.pl file, which gives permission to use, copy,
modify, and distribute this software and its documentation under the
terms of the GNU Public License.