summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-03-11 22:03:21 +0000
committerKarl Berry <karl@freefriends.org>2019-03-11 22:03:21 +0000
commit0b7ad48e8649c8021bce33948002008e76165b88 (patch)
treeeae0b29bac4f27307aa3b08ce8d0036e3593e6ad /Master/texmf-dist/doc
parent73fc8f1428dc92eee4f0fc4f3f8b8b5f163be79d (diff)
ctanbib (11mar19)
git-svn-id: svn://tug.org/texlive/trunk@50340 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/man/man1/ctanbib.172
-rw-r--r--Master/texmf-dist/doc/man/man1/ctanbib.man1.pdfbin0 -> 20182 bytes
-rw-r--r--Master/texmf-dist/doc/support/ctanbib/ctanbib-doc.pdfbin30489 -> 33837 bytes
-rw-r--r--Master/texmf-dist/doc/support/ctanbib/ctanbib-doc.tex48
4 files changed, 116 insertions, 4 deletions
diff --git a/Master/texmf-dist/doc/man/man1/ctanbib.1 b/Master/texmf-dist/doc/man/man1/ctanbib.1
new file mode 100644
index 00000000000..baa40b1190a
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man1/ctanbib.1
@@ -0,0 +1,72 @@
+.\" Manpage for ctanbib.
+.\" Contact michal.h21@gmail.com to correct errors or typos.
+.TH ctanbib 1 "28 aug 2018" "0.1" "ctanbib man page"
+.SH NAME
+ctanbib
+\- retrieve bibliographic information for packages hosted on CTAN.
+.SH SYNOPSIS
+ctanbib <options> [package name]
+.SH DESCRIPTION
+This command can retrieve bibliographic information for TeX packages hosted on
+CTAN in the BibTeX format.
+.SH OPTIONS
+.IP -c,--ctan
+use @ctan type instead of @manual. The difference between the two is that the
+url field contains package CTAN path, instead of link to the package.
+.IP -h,--help
+print the help message.
+.IP -v,--version
+print the version info.
+.SH EXAMPLES
+
+$ ctanbib latex
+
+.Pp
+This invocation will print data in the BibLaTeX format to the standard output:
+
+.nf
+.ft CW
+@manual{latex,
+title = {The Latex package},
+subtitle = {A TeX macro package that defines LaTeX},
+author = {Lamport, Leslie and The LaTeX Team},
+url = {http://www.latex-project.org/},
+urldate = {2018-08-23},
+date = {2018-04-01},
+version = {PL 5}
+}
+.ft R
+.fi
+
+.Pp
+The --ctan option:
+
+$ ctanbib -c hyperref
+
+.Pp
+This produces bib record with the @ctan type:
+
+.nf
+.ft CW
+@ctan{hyperref,
+title = {The Hyperref package},
+subtitle = {Extensive support for hypertext in LaTeX},
+author = {Rahtz, Sebastian and Oberdiek, Heiko},
+url = {/macros/latex/contrib/hyperref},
+urldate = {2018-08-27},
+date = {},
+version = {6.86b}
+}
+.ft R
+.fi
+
+.SH See also
+See ctanbib-doc.pdf for more details
+.SH BUGS
+No known bugs.
+.SH AUTHOR
+Michal Hoftich (michal.h21@gmail.com)
+.SH LICENSE
+Permission is granted to copy, distribute and/or modify this software
+under the terms of the LaTeX Project Public License, version 1.3.
+
diff --git a/Master/texmf-dist/doc/man/man1/ctanbib.man1.pdf b/Master/texmf-dist/doc/man/man1/ctanbib.man1.pdf
new file mode 100644
index 00000000000..2a48c8545c0
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man1/ctanbib.man1.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/support/ctanbib/ctanbib-doc.pdf b/Master/texmf-dist/doc/support/ctanbib/ctanbib-doc.pdf
index 74fa918fa00..9128765bd12 100644
--- a/Master/texmf-dist/doc/support/ctanbib/ctanbib-doc.pdf
+++ b/Master/texmf-dist/doc/support/ctanbib/ctanbib-doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/support/ctanbib/ctanbib-doc.tex b/Master/texmf-dist/doc/support/ctanbib/ctanbib-doc.tex
index 3a6c3a77ee6..699dee2765e 100644
--- a/Master/texmf-dist/doc/support/ctanbib/ctanbib-doc.tex
+++ b/Master/texmf-dist/doc/support/ctanbib/ctanbib-doc.tex
@@ -24,14 +24,27 @@ This package provides script named \package{ctanbib} which can be used for retri
It can be used in the following way:
-\noindent\package{ctanbib $\langle$packagename$\rangle$ > filename.bib}
+\noindent\package{ctanbib [options] $\langle$packagename$\rangle$ > filename.bib}
-\section{Example}
+
+\section{Available options}
+
+\begin{description}
+ \item[-c,-\/-ctan] use the \texttt{@ctan} type instead of \texttt{@manual}.
+ The difference between the two is that the url field contains packages CTAN
+ path, instead of a link to the package.
+ \item[-h,-\/-help] print the help message.
+ \item[-v,-\/-version] print the version info.
+\end{description}
+
+
+\section{Examples}
\begin{verbatim}
ctanbib latex
\end{verbatim}
+
\noindent This invocation will print data in the Bib\LaTeX\ format to the standard output:
\begin{verbatim}
@@ -46,21 +59,48 @@ version = {PL 5}
}
\end{verbatim}
+The \texttt{--ctan} option:
+
+\begin{verbatim}
+ctanbib -c hyperref
+\end{verbatim}
+
+\noindent This produces a bib record with the \texttt{@ctan} type:
+
+\begin{verbatim}
+@ctan{hyperref,
+title = {The Hyperref package},
+subtitle = {Extensive support for hypertext in LaTeX},
+author = {Rahtz, Sebastian and Oberdiek, Heiko},
+url = {/macros/latex/contrib/hyperref},
+urldate = {2018-08-27},
+date = {},
+version = {6.86b}
+}
+\end{verbatim}
+
+
\section{License}
Permission is granted to copy, distribute and/or modify this software
-under the terms of the LaTeX Project Public License, version 1.3.
+under the terms of the \LaTeX\ Project Public License, version 1.3.
\section{Acknowledgements}
This package was created thanks to TeX.sx user
Daniel\footnote{\url{https://tex.stackexchange.com/users/3751/daniel}}. Lukas
-C. Bossert had useful comments which led to update of the original script and
+C.~Bossert had useful comments which led to update of the original script and
it's eventual release on CTAN.
+\newpage
\section{Changelog}
\begin{changelog}
+ \change{2019-03-11}{Version 0.1b released}
+ \change{2018-09-10}{Added support for institutional names}
+ \change{2018-09-10}{Escape TeX commands in the title and subtitle}
+ \change{2018-08-29}{Added man page}
+ \change{2018-08-27}{Added --ctan option}
\change{2018-08-23}{Version 0.1 released.}
\change{2018-08-23}{Created documentation.}
\change{2018-08-21}{Rewrote the script to use the DOM api provided by LuaXML. This provides greater flexibility in the XML processing.}