TexCommons/README.md
2023-05-13 20:42:01 +02:00

30 lines
1.6 KiB
Markdown

The idea of this directory is to provide shared resources for preparing publications.
Most importantly it contains the makefile with common command packages to compile latex files.
## Usage
* 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
## Quick summary of commands
- `make (=make pdf)` complies .pdf from the root file.
- `make <filename>` tries to obtain `<filename>`, e.g. if `<filename>=foo.pdf` it will try
to compile `foo.tex` in order to get it no matter what `foo` is.
- `make clean` removes all target files obtained by latex in one round.
- `make cleanall` removes all target files.
- `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 show` shows the compiled `.pdf` using `xdg-open`.
- `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)