summaryrefslogtreecommitdiff
path: root/support/ctanbib/ctanbib.1
blob: 398919679bc691b5533fbfae8eeeda43f191a602 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
.\" Manpage for ctanbib.
.\" Contact michal.h21@gmail.com to correct errors or typos.
.TH ctanbib 1 "25 Oct 2023" "0.2d" "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.


Look up the Catalogue entry for each PKGNAME on CTAN (at
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,
https://ctan.org/pkg/PKGNAME is used.

.SH OPTIONS
.IP -c,--ctan 
Always use CTAN /pkg/ url instead of the package homepage 
.IP -C,--CTAN 
Use the package's CTAN path as url (e.g.: /support/ctanbib)
.IP -e,--entrytype 
(default manual)  Change entry type
.IP -h,--help 
print the help message.
.IP -p,--pkgname
Wrap the package name in a \ctanbibpkgname command
This command can be redefined in the document for the desired formatting.
.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.