Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 97 lines (62 sloc) 2.399 kb
0a81073 @falconindy Create POD file for man page
authored
1 =head1 NAME
2
9eae752 @falconindy doc: cleanup verbiage
authored
3 burp - an AUR uploader
0a81073 @falconindy Create POD file for man page
authored
4
5 =head1 SYNOPSIS
6
9eae752 @falconindy doc: cleanup verbiage
authored
7 I<burp> [options] packages...
0a81073 @falconindy Create POD file for man page
authored
8
9 =head1 DESCRIPTION
10
11 burp is a simple tool to upload packages to the AUR. It is written in C and
12 only depends on libcurl for its functionality.
13
9eae752 @falconindy doc: cleanup verbiage
authored
14 Invoking burp consists of supplying any applicable options and one or more
15 packages. Packages are tarballs generated by makepkg's --source operation.
16
0a81073 @falconindy Create POD file for man page
authored
17 =head1 OPTIONS
18
9885080 @falconindy doc: Add -k and -C options to man page. Reword some of the options to be...
authored
19 =over
0a81073 @falconindy Create POD file for man page
authored
20
a31b0fc @falconindy option is --user, not --username
authored
21 =item B<-u> I<USER>B<, --user=>I<USER>
0a81073 @falconindy Create POD file for man page
authored
22
9885080 @falconindy doc: Add -k and -C options to man page. Reword some of the options to be...
authored
23 AUR login username. If omitted and not specified in the config file, you will be
24 prompted to enter this at runtime.
0a81073 @falconindy Create POD file for man page
authored
25
9885080 @falconindy doc: Add -k and -C options to man page. Reword some of the options to be...
authored
26 =item B<-p> I<PASSWORD>B<, --password=>I<PASSWORD>B< >
0a81073 @falconindy Create POD file for man page
authored
27
9885080 @falconindy doc: Add -k and -C options to man page. Reword some of the options to be...
authored
28 AUR login password. If omitted and not specified in the config file, you will be
29 prompted to enter this at runtime.
0a81073 @falconindy Create POD file for man page
authored
30
31 =item B<-c> I<CAT>B<, --category=>I<CAT>
32
9885080 @falconindy doc: Add -k and -C options to man page. Reword some of the options to be...
authored
33 Specify I<CAT> to assign to uploaded packages. This should only be specified once.
34 If specified multiple times, the last will take precedence. If this option is not
35 specified, the category will default to type 'None' for new taurballs and the current
36 category for updated taurballs. A list of valid categories can be obtained by invoking
37 the -c flag with 'help'.
0a81073 @falconindy Create POD file for man page
authored
38
9885080 @falconindy doc: Add -k and -C options to man page. Reword some of the options to be...
authored
39 =item B<-C> I<FILE>B<, --cookies=>I<FILE>
0a81073 @falconindy Create POD file for man page
authored
40
9eae752 @falconindy doc: cleanup verbiage
authored
41 I<FILE> is the path in which to store cookies instead of the default temporary
42 file. If this file exists and is in valid Netscape cookie file format, login to
43 the AUR will be attempted using these cookies. Also see the -k option.
9885080 @falconindy doc: Add -k and -C options to man page. Reword some of the options to be...
authored
44
45 =item B<-k, --keep-cookies>
46
8823731 @falconindy doc: mention insistence of specifying a cookie file when -k is used
authored
47 Cookies will be persistent and reused for logins. If you specify this option, you must
48 also provide a cookie file path with the -C option or in the config file.
9885080 @falconindy doc: Add -k and -C options to man page. Reword some of the options to be...
authored
49
50 =item B<-v, --verbose>
51
52 Be more verbose. Pass this option twice to see debug info.
0a81073 @falconindy Create POD file for man page
authored
53
54 =back
55
af6919c @falconindy Rework POD file. Will be maintained as POD from now on rather than start...
authored
56 =head1 CONFIGURATION
0a81073 @falconindy Create POD file for man page
authored
57
7c455ff @falconindy Don't highlight valid config keynames...
authored
58 burp will look for a config file located at I<$XDG_CONFIG_HOME/burp/burp.conf>
0a81073 @falconindy Create POD file for man page
authored
59 and read default options from it in key=value format. Valid keys are:
60
9885080 @falconindy doc: Add -k and -C options to man page. Reword some of the options to be...
authored
61 =begin man
62
63 .sp
64 .RS 4
65 .nf
66 .BB lightgray
67 User = \fIUSER\fR
68 Password = \fIPASSWORD\fR
69 Cookies = \fIFILE\fR
70 Persist
71 .EB lightgray
72 .fi
73 .RE
74
75 =end man
76
5f97dd5 @falconindy doc: Duplicate config file key/val listing in its own section as pure PO...
authored
77 =begin html
78
79 <dd>
80 User = <i>USER</i><br/>
81 Password = <i>PASSWORD</i><br/>
82 Cookies = <i>FILE</i><br/>
83 Persist<br/>
84 </dd>
85
86 =end html
87
9885080 @falconindy doc: Add -k and -C options to man page. Reword some of the options to be...
authored
88 These should all be self explanatory. Comments, if desired, can be specified
89 with a #. Command line options will always take precedence over options specified
90 in the config file.
0a81073 @falconindy Create POD file for man page
authored
91
92
93 =head1 AUTHOR
94
95 Dave Reisner E<lt>d@falconindy.comE<gt>
96
Something went wrong with that request. Please try again.