summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/latex-git-log.1
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/latex-git-log.1')
-rw-r--r--Master/texmf-dist/doc/man/man1/latex-git-log.1253
1 files changed, 253 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/man/man1/latex-git-log.1 b/Master/texmf-dist/doc/man/man1/latex-git-log.1
new file mode 100644
index 00000000000..6d41c0caf92
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man1/latex-git-log.1
@@ -0,0 +1,253 @@
+.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
+.\"
+.\" 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
+..
+.\" Set up some character translations and predefined strings. \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote. \*(C+ will
+.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+. ds -- \(*W-
+. ds PI pi
+. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
+. ds L" ""
+. ds R" ""
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds -- \|\(em\|
+. ds PI \(*p
+. ds L" ``
+. ds R" ''
+'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 turned on, 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.
+.ie \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. nr % 0
+. rr F
+.\}
+.el \{\
+. de IX
+..
+.\}
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+. \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "LATEX-GIT-LOG 1"
+.TH LATEX-GIT-LOG 1 "2013-06-16" "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
+.SH "NAME"
+latex\-git\-log \- Generates the version history of a git project as LaTeX source code.
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+latex-git-log [options]
+.PP
+Options:
+.PP
+.Vb 10
+\& \-\-author set this if you want the author included
+\& \-\-startcommit set the start value of count commit
+\& \-\-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
+.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 \*(L"Overfull\*(R" 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 \s-1DIN\s0 A4 in landscape.
+.IP "\fB\-\-git\-c\-add\fR" 8
+.IX Item "--git-c-add"
+Set an base \s-1URL\s0 to link to a commit.
+This script will automatically try to use the base \s-1URL\s0 for github.
+.IP "\fB\-\-lang\fR" 8
+.IX Item "--lang"
+Set the language of the legend and all strings in the output. Be 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 module requires these other modules and libraries:
+.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 defined 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.
+.PP
+It is intended that you redirect the standard output of this script to a file
+which can then be included from your main TeX 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"
+0.9
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Robin Schneider <ypid23@aol.de>
+.SH "Development"
+.IX Header "Development"
+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 "LICENSE AND COPYRIGHT"
+.IX Header "LICENSE AND COPYRIGHT"
+Copyright (C) 2012\-2013 by Robin Schneider
+.PP
+This program is free software: you can redistribute it and/or modify
+it under the terms of the \s-1GNU\s0 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 \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
+\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. See the
+\&\s-1GNU\s0 General Public License for more details.
+.PP
+You should have received a copy of the \s-1GNU\s0 General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+.PP
+Dieses Programm ist Freie Software: Sie kA\*~Xnnen es unter den Bedingungen
+der \s-1GNU\s0 General Public License, wie von der Free Software Foundation,
+Version 3 der Lizenz oder (nach Ihrer Option) jeder spA\*~Xteren
+verA\*~Xffentlichten Version, weiterverbreiten und/oder modifizieren.
+.PP
+Dieses Programm wird in der Hoffnung, dass es nA\*~Xtzlich sein wird, aber
+\&\s-1OHNE\s0 \s-1JEDE\s0 GEWA\*~XHRLEISTUNG, bereitgestellt; sogar ohne die implizite
+GewA\*~Xhrleistung der MARKTFA\*~XHIGKEIT oder \s-1EIGNUNG\s0 FA\*~XR \s-1EINEN\s0 \s-1BESTIMMTEN\s0 \s-1ZWECK\s0.
+Siehe die \s-1GNU\s0 General Public License fA\*~Xr weitere Details.
+.PP
+Sie sollten eine Kopie der \s-1GNU\s0 General Public License zusammen mit diesem
+Programm erhalten haben. Wenn nicht, siehe <http://www.gnu.org/licenses/>.