Added a OUTPUTTYPE example.
[clinton/abcde.git] / cddb-tool.1
1 .TH CDDB-TOOL 1
2 .SH NAME
3 cddb-tool \- Get CDDB information
4 .SH SYNOPSIS
5 .B cddb-tool parse
6 .I file [-i|-d|-a|-t] [num|-c|-p]
7
8 .B cddb-tool template disc-id tracks
9
10 .B cddb-tool send
11 .I [file] address
12
13 .B cddb-tool query
14 .I server user host disc-id tracks
15
16 .B cddb-tool read
17 .I server user host disc-id genre
18
19 .B cddb-tool help
20
21 .SH DESCRIPTION
22 cddb-tool is a backend tool for abcde. It is passed information from
23 cd-discid and uses it look up the CD title, artist, and track information
24 on the cddb database (http://freedb.freedb.org) on the internet.
25 .SH COMMANDS
26 .B parse
27 .I [file] option
28
29 Get data out of a cddb file (use "-" for stdin).
30 Options (use one and only one):
31 .RS
32 .TP
33 .B id
34 prints disc id
35 .TP
36 .B album
37 prints album title
38 .TP
39 .B track num
40 prints title of track num
41 .TP
42 .B
43 artist
44 prints artist
45 .TP
46 .B category
47 prints category
48 .TP
49 .B cddbgenre
50 synonym for category
51 .TP
52 .B all
53 parse file and dumps to stdout in a form sourceable by the shell
54 .RE
55
56 .B send
57 .I [file] address
58
59 Mails file file (or stdin of no file specified)
60 to specified address, using correct format. Category should
61 be one of blues, classical, country, data, folk, jazz, newage,
62 reggae, rock, soundtrack, misc.
63
64 .B template
65 .I [disc-id] [tracks]
66
67 Generates a template (empty) cddb file to stdout. The command
68 line should be essentially the output of cd-discid.
69
70 .B query
71 .I [server] [user] [host] [disc-id] [tracks]
72
73 Looks up disc on server (should be of form "http://host/cddb/cddb.cgi")
74 remainder of command line is in the same form as that returned
75 by the cd-discid program. Uses wget, so if you need to use a proxy
76 then just configure wget to do so. user and host will be used for
77 identifying ourselves to the CDDB server. Outputs response code and entries
78 with matching CDDB entries, if successful, from the CDDB server.
79
80
81 .B read
82 .I [server] [user] [host] [disc-id] [genre]
83
84 Dumps CDDB entry to stdout. File will contain an extra #CATEGORY=
85 line, which leaves it a valid CDDB file but which will be recognized
86 by parse and send commands. Uses wget, so if you need to use a proxy
87 then just configure wget to do so. user and host will be used for
88 identifying ourselves to the CDDB server.
89
90 .B help
91
92 Prints usage information.
93
94 .SH AUTHOR
95 Nathaniel Smith <njs@uclink4.berkeley.edu>, maintained as part of abcde by
96 Robert Woodcock <rcw@debian.org>. Manual page compiled from help information
97 by Robert Woodcock.