Debian Codegraph @

texmf-dist/doc/man/man1/latex-git-log.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "LATEX-GIT-LOG 1"
58 .TH LATEX-GIT-LOG 1 2024-05-31 latex-git-log "Robin Schneider"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 latex-git-log \- Generates the version history of a git project as LaTeX source code.
64 .SH Synopsis
65 .IX Header "Synopsis"
66 latex-git-log [options] [file] ...
67 .PP
68 Options:
69 .PP
70 .Vb 10
71 \& \-\-author set this if you want the author included
72 \& \-\-width set the width in cm of the commit message field in the LaTeX table
73 \& \-\-git\-c\-add set an base URL to link to a commit
74 \& \-\-user set a github user to derive the base URL
75 \& \-\-repo set a github repository to derive the base URL
76 \& \-\-lang language of the legend and all strings in the output
77 \& \-\-version, \-v print version of this script
78 \& \-\-help brief help message
79 \& \-\-man full documentation
80 \& \-\-range specify a git revision range
81 .Ve
82 .SH Options
83 .IX Header "Options"
84 .IP \fB\-\-width\fR 8
85 .IX Item "--width"
86 Set the width in cm of the commit message field in the LaTeX table. If this
87 parameter is not set then the table is not vertically limited. That means that
88 if you have a very long commit message then the table will probably not fit on
89 the page and you will get a "Overfull" error message from TeX.
90 .Sp
91 In this case you should specify the width of the column containing the commit messages.
92 I normally use something like \-\-width=14 for DIN A4 in landscape.
93 .IP \fB\-\-git\-c\-add\fR 8
94 .IX Item "--git-c-add"
95 Set an base URL to link to a commit.
96 This script will automatically try to use the base URL for github.
97 .IP \fB\-\-lang\fR 8
98 .IX Item "--lang"
99 Set the language of the legend and all strings in the output. By default the
100 language of your system is used but you can overwrite this with this parameter.
101 .Sp
102 Currently this script only supports English and German. If you need a translation
103 to another language then you can either create a .po file or I can register
104 this project on one of those websites for online translation.
105 .SH Example
106 .IX Header "Example"
107 You can use it like this:
108 .PP
109 .Vb 1
110 \& latex\-git\-log \-\-width=6 \-\-lang=en > example\-output.tex
111 .Ve
112 .SH Dependencies
113 .IX Header "Dependencies"
114 .SS "Of this script"
115 .IX Subsection "Of this script"
116 This script requires the following Perl modules:
117 .PP
118 .Vb 2
119 \& IPC::System::Simple
120 \& Locale::Maketext::Simple
121 .Ve
122 .PP
123 Everything else should already be installed.
124 .SS "To compile the output"
125 .IX Subsection "To compile the output"
126 The table is using the \fBlongtable\fR package and the links to a web resource for
127 each commit use the \ehref macro from \fBhyperref\fR. So these two packages have to
128 be loaded.
129 .PP
130 Furthermore you need to defined the macro \fB\elongtableendfoot\fR which will be
131 expanded on the bottom of every page if the table will be continued on the next
132 page. You can define it to a localized message to inform the reader that this
133 table is not complete and will be continued.
134 .SH Description
135 .IX Header "Description"
136 \&\fBThis program\fR will output the entire version history as table written in
137 LaTeX if it is executed within a git repository.
138 When \fIfile\fR argument(s) are given, only the history that changed these file(s)
139 will be output.
140 .PP
141 It is intended that you redirect the standard output of this script to a file
142 which can then be included from your main LaTeX document.
143 .PP
144 Because the table can be very large you might want to put the thing on a
145 landscape page.
146 .SH Version
147 .IX Header "Version"
148 1.1.0
149 .SH Author
150 .IX Header "Author"
151 Robin Schneider <[email protected]>
152 .SH Development
153 .IX Header "Development"
154 CTAN: https://ctan.org/pkg/latex\-git\-log
155 .PP
156 Source code repository: https://github.com/ypid/typesetting/tree/master/scripts/latex\-git\-log
157 .PP
158 Please report bugs and feature requests at https://github.com/ypid/typesetting/issues
159 .SH "Bugs and limitations"
160 .IX Header "Bugs and limitations"
161 .IP \(bu 4
162 The translation features does not seem to work. So this script is unable to output German. English works.
163 .SH "License and Copyright"
164 .IX Header "License and Copyright"
165 Copyright (C) 2012\-2013,2017,2019\-2020,2024 Robin Schneider <[email protected]>
166 .PP
167 This program is free software: you can redistribute it and/or modify
168 it under the terms of the GNU General Public License as published by
169 the Free Software Foundation, either version 3 of the License, or
170 (at your option) any later version.
171 .PP
172 This program is distributed in the hope that it will be useful,
173 but WITHOUT ANY WARRANTY; without even the implied warranty of
174 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
175 GNU General Public License for more details.
176 .PP
177 You should have received a copy of the GNU General Public License
178 along with this program. If not, see <http://www.gnu.org/licenses/>.