Debian Codegraph @

texmf-dist/doc/man/man1/ctanbib.1

raw
1 .\" Manpage for ctanbib.
2 .\" Contact [email protected] to correct errors or typos.
3 .TH CTANBIB 1 "2026-05-26" "0.2e" "ctanbib man page"
4 .SH NAME
5 ctanbib - retrieve bibliographic information for packages hosted on CTAN
6 .SH SYNOPSIS
7 ctanbib [\fIoptions\fP] \fIpackage-name\fP ...
8 .SH DESCRIPTION
9 This command can retrieve bibliographic information for TeX packages hosted on
10 CTAN in the BibTeX format.
11 .PP
12 Look up the Catalogue entry for each \fIpackage-name\fP on CTAN (at
13 https://ctan.org/xml/2.0/pkg/\fIpackage-name\fP), and convert relevant
14 information to a BibTeX entry.
15 .PP
16 By default, the url field in the output entry is the package's home
17 field value if that is specified in the Catalogue entry; if it isn't, or
18 if the --ctan option is given, https://ctan.org/pkg/\fIpackage-name\fP
19 is used. Or, if the --CTAN option is given, the url field is the
20 package's directory on CTAN (e.g., /macros/latex/contrib/hyperref).
21
22 .SH OPTIONS
23 .IP -c,--ctan
24 Always use CTAN /pkg/ url instead of the package homepage
25 .IP -C,--CTAN
26 Use the package's CTAN path as url (e.g.: /support/ctanbib)
27 .IP -e,--entrytype
28 (default manual) Change entry type
29 .IP -h,--help
30 print the help message.
31 .IP -p,--pkgname
32 Wrap the package name in a \\ctanbibpkgname command.
33 This command can be redefined in the document for the desired formatting.
34 .IP -v,--version
35 print the version info.
36
37 .SH EXAMPLES
38
39 .EX
40 ctanbib latex
41 .EE
42 .PP
43 This minimal invocation will print data using conventional BibLaTeX
44 fields to standard output:
45 .EX
46 @manual{latex,
47 title = {The latex package},
48 subtitle = {A TeX macro package that defines LaTeX},
49 author = {Lamport, Leslie and {The LaTeX Project Team}},
50 url = {http://www.latex-project.org/},
51 urldate = {2026-05-18},
52 date = {2025-11-01},
53 version = {},
54 }
55 .EE
56 .PP
57 Note that the output does not use TeX control sequences or have
58 completely correct capitalization. \fBctanbib\fP works only from the
59 (plain text) data available from CTAN; any typesetting niceties are up
60 to you.
61
62 .PP
63 With the --entrytype option:
64 .EX
65 ctanbib -e ctan hyperref
66 .EE
67 .PP
68 This produces a bib record with the @ctan type:
69 .EX
70 @ctan{hyperref,
71 title = {The hyperref package},
72 subtitle = {Extensive support for hypertext in LaTeX},
73 author = {Oberdiek, Heiko and Rahtz, Sebastian
74 and {Oberdiek Package Support Group}
75 and {The LaTeX Project Team}},
76 url = {https://github.com/latex3/hyperref},
77 urldate = {2026-05-18},
78 date = {2026-04-24},
79 version = {7.01q},
80 }
81 .EE
82
83 .SH SEE ALSO
84
85 See ctanbib-doc.pdf (run: texdoc ctanbib) for more details.
86
87 .SH AUTHOR
88
89 Michal Hoftich
90 .br
91 https://github.com/michal-h21/ctanbib
92
93 .SH LICENSE
94
95 Permission is granted to copy, distribute and/or modify this software
96 under the terms of the LaTeX Project Public License, either version 1.3
97 of this license or (at your option) any later version.