summaryrefslogtreecommitdiff
path: root/support/ctantools/README
blob: 12ab70fa1489a61573ff7e011d49f0963b36b807 (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
ABOUT
	This jifty tool helps you to seach/download LaTeX packages listed at
		http://ctan.org/tex-archive/macros/latex/contrib/
	or search/download any files in http://ctan.org/tex-archive (or its mirror).

	The tool requires following programs
		lynx wget tar bzip2 sed sort awk grep

	This tool was written by Anh K. Huynh <xkyanh@gmail.com>.
VERSION
	1.0.0 2008/05/11: first version
	1.1.0 2008/05/15: search files (use cache file)
	1.2.0 2008/05/16: smaller cache. Thanks to Karl Berry <karl@freefriends.org>
	1.3.0 2008/05/23: everything is cached. Faster. New options. Thanks to texer.
	1.4.0 2009/09/12: auto. select ctan mirror (suggested by Jim Hefferon)
	1.5.0 2009/09/13: load database from http://mirror.ctan.org/FILES.byname
USAGE
	ctan about           : show all information about this tool
	ctan usage           : show usage
	ctan version         : show script version

	ctan update          : update using http://viettug.org/ctan.tools//cache.tbz (~1MB)
	ctan update --direct : update directly from CTAN. You are going to download 8MB
	ctan grep <string>   : search packages match <string>. grep ability is supported
	ctan get  <string>   : download packages match <string> to working directory

	If you want to search files:

	ctan fgrep <string>  : search files.
	ctan fget  <string>  : download files match <string> to working directory
	ctan grep -file <string>
	ctan get  -file <string>
EXAMPLES
	ctan grep theorem    # search packages match 'theorem'
	ctan grep ^n         # search packages srated by 'n'
	ctan get  ^n         # download packages started by 'n'

	ctan get -file contrib/ntheorem.zip
	ctan fget      contrib/ntheorem.zip
	ctan fgrep     ntheorem | grep zip
TODO
	* package information supported
	* search by package description,...
	* package build script
THANKS to
	* Karl Berry <karl@freefriends.org>
	* Nguyen Van Hanh <hanhnguyenvan@gmail.com>
	* Jim Hefferon <ftpmaint@alan.smcvt.edu>
LICENSE
	This tool is published under LPPL.
BUGS
	Please report to kyanh <xkyanh@gmail.com>.