-
Notifications
You must be signed in to change notification settings - Fork 9
/
ccr-tools.8
160 lines (141 loc) · 3.43 KB
/
ccr-tools.8
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
'\" t
.\" Title: ccr-tools
.\" Author: [see the "Authors" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 04/29/2012
.\" Manual: ccr-tools Manual
.\" Source: ccr-tools
.\" Language: English
.\"
.TH "ccr-tools" "8" "04/29/2012" "ccr-tools" "ccr-tools Manual"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ccr-tools \- utility for CCR packagers
.SH "SYNOPSIS"
.sp
\fIccr-tools\fR [options] [packages]
.SH "DESCRIPTION"
.sp
ccr-tools is a bash script that allows you to submit, (un)vote and list information on the packages of the Chakra Community Repository from the comfort of your shell\&.
.SH "OPTIONS"
.PP
\fB\-\-check\fR <package-name>, \fB\-c\fR <package-name>
.RS 4
Check to see if you have voted for a package or packages in CCR\&.
.RE
.PP
\fB\-\-forget\fR, \fB\-m\fR
.RS 4
Deletes your cookie when the script finishes\&.
.RE
.PP
\fB\-\-help\fR, \fB\-h\fR
.RS 4
Output a short help and exit\&.
.RE
.PP
\fB\-\-maintainer\fR <maintainer-username>, \fB\-m\fR <maintainer-username>
.RS 4
Search for all packages owned by a CCR user\&. When <maintainer-username> is not given, it defaults to your username\&.
.RE
.PP
\fB\-\-unvote\fR <package-name>, \fB\-u\fR <package-name>
.RS 4
Remove your vote for a package or packages in CCR\&.
.RE
.PP
\fB\-\-version\fR, \fB\-V\fR
.RS 4
Show version information and exit\&.
.RE
.PP
\fB\-\-vote\fR <package-name>, \fB\-v\fR <package-name>
.RS 4
Vote for a package or packages in CCR\&.
.RE
.PP
\fB\-\-submit\fR <package-source>, \fB\-s\fR <package-source>
.RS 4
Submit a package to the CCR\&.
.RE
.PP
\fB\-\-category\fR <category-name>, \fB\-C\fR <category-name>
.RS 4
Select the category for the submitted package\&. Can only be used with \-\-submit
.RE
.PP
.SH "EXAMPLE USAGE"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Submit a new package foo:
ccr-tools \-\-submit foo.src.tar.gz --category devel
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Update an already existing package bar:
ccr-tools \-\-submit bar.src.tar.gz
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Vote for packages foo, bar and baz:
ccr-tools \-\-vote foo bar baz
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
List all packages maintained by you, sorted by category [see \fBsort\fR(1)]:
ccr-tools \-m | sort \-k3
.RE
.sp
.SH "CONFIGURATION"
.sp
A configuration file is located at ~/.config/ccr-tools/config\&. You can set your CCR username and password here\&. If you don\'t, the script will ask for them each time\&. You can also set whether or not your session should be saved, by changing the value of the \'rememberme\' variable\&.
.sp
.SH "KNOWN BUGS"
.sp
A few, especially in the argument parsing code\&. An update will be release soon, fixing these bugs\&.
.sp
.SH "REPORTING BUGS"
.sp
Please report bugs at: <https://github.com/ccr-tools/ccr-tools/issues/>
.sp
.SH "AUTHORS"
.sp
Ram-Z and the other members of the ccr-tools team (https://github.com/ccr-tools/)
.sp