summaryrefslogtreecommitdiff
path: root/support/ctanbib/ctanbib-doc.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2023-10-26 03:01:46 +0000
committerNorbert Preining <norbert@preining.info>2023-10-26 03:01:46 +0000
commit721b0492f150d59f61b504ab803c7ef1a9a67a0b (patch)
tree95c682efcdefd7abd304cc7fb6ffe1d843d818a8 /support/ctanbib/ctanbib-doc.tex
parent241082cbe6f4fe8c38e91c38418ca828ac8d2f7c (diff)
CTAN sync 202310260301
Diffstat (limited to 'support/ctanbib/ctanbib-doc.tex')
-rw-r--r--support/ctanbib/ctanbib-doc.tex53
1 files changed, 33 insertions, 20 deletions
diff --git a/support/ctanbib/ctanbib-doc.tex b/support/ctanbib/ctanbib-doc.tex
index 9f7ce00b8b..c13d62564b 100644
--- a/support/ctanbib/ctanbib-doc.tex
+++ b/support/ctanbib/ctanbib-doc.tex
@@ -1,4 +1,4 @@
-\documentclass{ltxdoc}
+\documentclass[11pt]{ltxdoc}
\newcommand\package[1]{\texttt{#1}}
\usepackage{longtable}
\usepackage{tabularx}
@@ -18,6 +18,13 @@
\section{Introduction}
This package provides script named \package{ctanbib} which can be used for retrieving of the bibliographic information for packages hosted on CTAN.
+It looks up the Catalogue entry for each PKGNAME on CTAN (at
+\url{https://ctan.org/xml/2.0/pkg/PKGNAME}), and convert relevant information
+to a BibTeX entry.
+
+By default, the url field in the output entry is the package's home
+field value if that is specified in the Catalogue entry; if it isn't,
+\url{https://ctan.org/pkg/PKGNAME is used}.
\section{Usage}
@@ -37,11 +44,11 @@ The \texttt{curl} utility needs to be installed on the user's system in order to
\section{Available options}
\begin{description}
- \item[-c,-\/-ctan] use the CTAN package entry as package URL instead of URL provided by the package.
- \item[-C,-\/-ctanpath] use package's CTAN path as URL
+ \item[-c,-\/-ctan] always use CTAN /pkg/ url instead of the package homepage
+ \item[-C,-\/-ctanpath] use the package's CTAN path as url (e.g.: /support/ctanbib)
\item[-e,-\/-entrypoint] explicitly set the Bib\TeX\ entry type.
\item[-h,-\/-help] print the help message.
- \item[-p,-\/-pkgname] Put the package name in a \verb|\ctanbibpkgname| command.
+ \item[-p,-\/-pkgname] wrap the package name in a \verb|\ctanbibpkgname| command.
\item[-v,-\/-version] print the version info.
\end{description}
@@ -53,17 +60,17 @@ ctanbib latex
\end{verbatim}
-\noindent This invocation will print data in the Bib\LaTeX\ format to the standard output:
+\noindent This invocation will print data in the Bib(La)\TeX\ format to the standard output:
\begin{verbatim}
@manual{latex,
-title = {The latex package},
-subtitle = {A TeX macro package that defines LaTeX},
-author = {{The LaTeX Team} and Lamport, Leslie},
-url = {http://www.latex-project.org/},
-urldate = {2021-06-26},
-date = {},
-version = {2021-06-01},
+ title = {The latex package},
+ subtitle = {A TeX macro package that defines LaTeX},
+ author = {{The LaTeX Team} and Lamport, Leslie},
+ url = {http://www.latex-project.org/},
+ urldate = {2021-06-26},
+ date = {},
+ version = {2021-06-01},
}
\end{verbatim}
@@ -79,10 +86,10 @@ instead of the original package URL.
\begin{verbatim}
@manual{latex,
-title = {The latex package},
-...
-url = {https://ctan.org/pkg/latex},
-...
+ title = {The latex package},
+ ...
+ url = {https://ctan.org/pkg/latex},
+ ...
}
\end{verbatim}
@@ -96,9 +103,9 @@ ctanbib -C biblatex
\begin{verbatim}
@manual{biblatex,
-...
-url = {/macros/latex/contrib/biblatex},
-...
+ ...
+ url = {/macros/latex/contrib/biblatex},
+ ...
}
\end{verbatim}
@@ -114,7 +121,7 @@ ctanbib -e ctan latex
\begin{verbatim}
@ctan{latex,
-...
+ ...
}
\end{verbatim}
@@ -154,6 +161,12 @@ and leaving package names uncapitalized.
\section{Changelog}
\begin{changelog}
+ \change{2023-10-25}{Version 0.2d released}
+ \change{2023-10-20}{Sort authors alphabetically}
+ \change{2023-10-19}{Updated the \verb|--help| message}
+ \change{2023-10-16}{Use larger font in the documentation}
+ \change{2023-10-16}{Indent the Bib\TeX\ entry by two spaces}
+ \change{2023-10-08}{Get date from the copyright field if we cannot retrieve it from version}
\change{2023-09-18}{Version 0.2c released}
\change{2023-09-14}{Renamed the \verb|--tugboat| option to \verb|--pkgname|}
\change{2023-09-12}{Don't capitalize package names}