Public/TexCommons
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
o-da 2023-05-13 20:42:01 +02:00
parent 1d7d19a97f
commit 6b8c7447b5
1 changed files with 23 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -2,19 +2,28 @@ The idea of this directory is to provide shared resources for preparing publicat
Most importantly it contains the makefile with common command packages to compile latex files. Most importantly it contains the makefile with common command packages to compile latex files.
In order to use it, create a makefile in your directory with the same name with the only content. ## Usage
'include <path-to-this-dir>/Makefile'. If your directory contains more than one root latex file
add 'SRCNAME=<name-of-root-file>' before the include command.
== Quick summary of commands == * Add a submodule to your git repository with `git submodule add git@git8.cs.fau.de:public-repos/TexCommon.git` or `<relative path>/public-repos/TexCommon.git`
* Run `git submodule update --init` or `git submodule update --recursive` in `TexCommon` if it is empty
* Use `git pull origin master` in `TexCommon` to update to the latest version
* Add the `Makefile` to your repository with the content
```
export TEXINPUTS:=${TEXINPUTS}:.:TexCommon
SRCNAMES := <list of files to compile>
include TexCommon/Makefile
```
* If `SRCNAMES` is omitted, it will be computed automatically
- make (=make pdf) - complies .pdf from the root file ## Quick summary of commands
- make <filename> - tries to achieve <filename> in a suitable way, e.g. if <filename>=foo.pdf it will try
to compile foo.tex in order to get it no matter what 'foo' is. - `make (=make pdf)` complies .pdf from the root file.
- make clean - removes all target files obtained by latex in one round. - `make <filename>` tries to obtain `<filename>`, e.g. if `<filename>=foo.pdf` it will try
- make cleanall - removes all target files. to compile `foo.tex` in order to get it no matter what `foo` is.
- make up - uploads the compiled .pdf and .ps files on the server to the current user's directory under t - `make clean` removes all target files obtained by latex in one round.
same name unless overridden by $EXTNAME variable. - `make cleanall` removes all target files.
- make show - shows the compiled .dvi in xdvi - `make up` uploads the compiled `.pdf` and `.ps` files on the server to the current user's directory under the same name unless overridden by `$EXTNAME` variable.
- make bibtex - runs bibtex for all .bib files of the current directory - `make show` shows the compiled `.pdf` using `xdg-open`.
- make bibtool - normalizes the the .bib files by calling bibtool with the settings given in bibtool.rc - `make bibtex` runs bibtex for all `.bib` files of the current directory.
- `make bibtool` normalizes the the `.bib` files by calling bibtool with the settings given in `bibtool.rc`
- `make pack` create a zipped file of a final version of the paper (usually needs manual postprocessing)