1LATEX-GIT-LOG(1)                Robin Schneider               LATEX-GIT-LOG(1)
2
3
4

NAME

6       latex-git-log - Generates the version history of a git project as LaTeX
7       source code.
8

SYNOPSIS

10       latex-git-log [options]
11
12       Options:
13
14         --author          set this if you want the author included
15         --startcommit     set the start value of count commit
16         --width           set the width in cm of the commit message field in the LaTeX table
17         --git-c-add       set an base URL to link to a commit
18         --user            set a github user to derive the base URL
19         --repo            set a github repository to derive the base URL
20         --lang            language of the legend and all strings in the output
21         --version, -v     print version of this script
22         --help            brief help message
23         --man             full documentation
24

OPTIONS

26       --width Set the width in cm of the commit message field in the LaTeX
27               table. If this parameter is not set then the table is not
28               vertically limited. That means that if you have a very long
29               commit message then the table will probably not fit on the page
30               and you will get a "Overfull" error message from TeX.
31
32               In this case you should specify the width of the column
33               containing the commit messages.  I normally use something like
34               --width=14 for DIN A4 in landscape.
35
36       --git-c-add
37               Set an base URL to link to a commit.  This script will
38               automatically try to use the base URL for github.
39
40       --lang  Set the language of the legend and all strings in the output.
41               Be default the language of your system is used but you can
42               overwrite this with this parameter.
43
44               Currently this script only supports English and German. If you
45               need a translation to another language then you can either
46               create a .po file or I can register this project on one of
47               those websites for online translation.
48

Example

50       You can use it like this:
51
52           latex-git-log --width=6 --lang=en > example-output.tex
53

DEPENDENCIES

55   Of this script
56       This module requires these other modules and libraries:
57
58           IPC::System::Simple
59           Locale::Maketext::Simple
60
61       Everything else should already be installed.
62
63   To compile the output
64       The table is using the longtable package and the links to a web
65       resource for each commit use the \href macro from hyperref. So these
66       two packages have to be loaded.
67
68       Furthermore you need to defined the macro \longtableendfoot which will
69       be expanded on the bottom of every page if the table will be continued
70       on the next page. You can defined it to a localized message to inform
71       the reader that this table is not complete and will be continued.
72

DESCRIPTION

74       This program will output the entire version history as table written in
75       LaTeX if it is executed within a git repository.
76
77       It is intended that you redirect the standard output of this script to
78       a file which can then be included from your main TeX document.
79
80       Because the table can be very large you might want to put the thing on
81       a landscape page.
82

Version

84       0.9
85

AUTHOR

87       Robin Schneider <ypid23@aol.de>
88

Development

90       Source code repository:
91       https://github.com/ypid/typesetting/tree/master/scripts/latex-git-log
92
93       Please report bugs and feature requests at
94       https://github.com/ypid/typesetting/issues
95

97       Copyright (C) 2012-2013 by Robin Schneider
98
99       This program is free software: you can redistribute it and/or modify it
100       under the terms of the GNU General Public License as published by the
101       Free Software Foundation, either version 3 of the License, or (at your
102       option) any later version.
103
104       This program is distributed in the hope that it will be useful, but
105       WITHOUT ANY WARRANTY; without even the implied warranty of
106       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
107       General Public License for more details.
108
109       You should have received a copy of the GNU General Public License along
110       with this program.  If not, see <http://www.gnu.org/licenses/>.
111
112       Dieses Programm ist Freie Software: Sie kA~Xnnen es unter den
113       Bedingungen der GNU General Public License, wie von der Free Software
114       Foundation, Version 3 der Lizenz oder (nach Ihrer Option) jeder
115       spA~Xteren verA~Xffentlichten Version, weiterverbreiten und/oder
116       modifizieren.
117
118       Dieses Programm wird in der Hoffnung, dass es nA~Xtzlich sein wird,
119       aber OHNE JEDE GEWA~XHRLEISTUNG, bereitgestellt; sogar ohne die
120       implizite GewA~Xhrleistung der MARKTFA~XHIGKEIT oder EIGNUNG FA~XR
121       EINEN BESTIMMTEN ZWECK.  Siehe die GNU General Public License fA~Xr
122       weitere Details.
123
124       Sie sollten eine Kopie der GNU General Public License zusammen mit
125       diesem Programm erhalten haben. Wenn nicht, siehe
126       <http://www.gnu.org/licenses/>.
127
128
129
130latex-git-log                     2013-06-16                  LATEX-GIT-LOG(1)
Impressum