.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "LATEX-GIT-LOG 1" .TH LATEX-GIT-LOG 1 2024-05-31 latex-git-log "Robin Schneider" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh latex-git-log \- Generates the version history of a git project as LaTeX source code. .SH Synopsis .IX Header "Synopsis" latex-git-log [options] [file] ... .PP Options: .PP .Vb 10 \& \-\-author set this if you want the author included \& \-\-width set the width in cm of the commit message field in the LaTeX table \& \-\-git\-c\-add set an base URL to link to a commit \& \-\-user set a github user to derive the base URL \& \-\-repo set a github repository to derive the base URL \& \-\-lang language of the legend and all strings in the output \& \-\-version, \-v print version of this script \& \-\-help brief help message \& \-\-man full documentation \& \-\-range specify a git revision range .Ve .SH Options .IX Header "Options" .IP \fB\-\-width\fR 8 .IX Item "--width" Set the width in cm of the commit message field in the LaTeX table. If this parameter is not set then the table is not vertically limited. That means that if you have a very long commit message then the table will probably not fit on the page and you will get a "Overfull" error message from TeX. .Sp In this case you should specify the width of the column containing the commit messages. I normally use something like \-\-width=14 for DIN A4 in landscape. .IP \fB\-\-git\-c\-add\fR 8 .IX Item "--git-c-add" Set an base URL to link to a commit. This script will automatically try to use the base URL for github. .IP \fB\-\-lang\fR 8 .IX Item "--lang" Set the language of the legend and all strings in the output. By default the language of your system is used but you can overwrite this with this parameter. .Sp Currently this script only supports English and German. If you need a translation to another language then you can either create a .po file or I can register this project on one of those websites for online translation. .SH Example .IX Header "Example" You can use it like this: .PP .Vb 1 \& latex\-git\-log \-\-width=6 \-\-lang=en > example\-output.tex .Ve .SH Dependencies .IX Header "Dependencies" .SS "Of this script" .IX Subsection "Of this script" This script requires the following Perl modules: .PP .Vb 2 \& IPC::System::Simple \& Locale::Maketext::Simple .Ve .PP Everything else should already be installed. .SS "To compile the output" .IX Subsection "To compile the output" The table is using the \fBlongtable\fR package and the links to a web resource for each commit use the \ehref macro from \fBhyperref\fR. So these two packages have to be loaded. .PP Furthermore you need to defined the macro \fB\elongtableendfoot\fR which will be expanded on the bottom of every page if the table will be continued on the next page. You can define it to a localized message to inform the reader that this table is not complete and will be continued. .SH Description .IX Header "Description" \&\fBThis program\fR will output the entire version history as table written in LaTeX if it is executed within a git repository. When \fIfile\fR argument(s) are given, only the history that changed these file(s) will be output. .PP It is intended that you redirect the standard output of this script to a file which can then be included from your main LaTeX document. .PP Because the table can be very large you might want to put the thing on a landscape page. .SH Version .IX Header "Version" 1.1.0 .SH Author .IX Header "Author" Robin Schneider .SH Development .IX Header "Development" CTAN: https://ctan.org/pkg/latex\-git\-log .PP Source code repository: https://github.com/ypid/typesetting/tree/master/scripts/latex\-git\-log .PP Please report bugs and feature requests at https://github.com/ypid/typesetting/issues .SH "Bugs and limitations" .IX Header "Bugs and limitations" .IP \(bu 4 The translation features does not seem to work. So this script is unable to output German. English works. .SH "License and Copyright" .IX Header "License and Copyright" Copyright (C) 2012\-2013,2017,2019\-2020,2024 Robin Schneider .PP This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. .PP This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. .PP You should have received a copy of the GNU General Public License along with this program. If not, see .