This repository has been archived by the owner on Sep 20, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cpak.1
183 lines (150 loc) · 4.52 KB
/
cpak.1
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
.TH CPAK 1 cpak-__VERSION__
.SH NAME
cpak - the fast and efficient source based package manager for the c programming language
.SH SYNOPSIS
.B cpak
.RI [ COMMAND ]
.RI [ SUBCOMMAND | FLAG ]
.P
.SH DESCRIPTION
Cpak makes it easy for the developer to manage packages for c projects,
by allowing devs to store project dependencies globally or inside a project.
It also enables a templating and bootstraping toolkit.
Cpak features a extensive documentation and a very verbose logging system
to warn the users of malformatted config files and several other nuances.
.TP
.B version
Show the program version.
.TP
.B help
Verbose help for every command and subcommand available.
If no subcommand is given, the cpak usage is displayed.
This command does not accept short version of commands, use full names.
.TP
.B config
Generates the default cpak config and the default template in
.B CPAK_CONFIG_HOME/cpak
or
.B XDG_CONFIG_HOME/cpak.
If there is already a configuration present at one of these locations the config will not be overridden this config unless the
.B -f
force flag is specifed as a subcommand.
.TP
.B bootstrap
Copies the files specified in a subdirectory in
.B CPAK_CONFIG_HOME/cpak/templates/<template_name>
or
.B XDG_CONFIG_HOME/cpak/templates/<template_name>.
Also executes the
.B cpak_template.sh
file found in the template directory in the newly bootstraped directory.
.TP
.B add
Adds a new module to the module registry in
.B CPAK_MODULE_HOME
or
.B XDG_DATA_HOME/cpak.
This command also creates a soft link in the current directory to the installed module in the
.B cpak_modules
directory. This command requires the module to be formatted in the following way:
<repo_owner>/<repo_name>
.TP
.B remove
Removes the specified module from the module registry in
.B CPAK_MODULE_HOME
or
.B XDG_DATA_HOME/cpak.
This command also unlinks the module soft link in the current directory to the installed module in the
.B cpak_modules
directory. In contrary to the
.B add
command, this command only needs the module name.
.TP
.B upgrade
Syncs the specified installed module to the newest upstream commit.
This command also only needs the module name as a subcommand.
.SH EXAMPLES:
The following examples make use of the short version commands, all of them can be called by the full name of the command.
.TP
.B version
Get the installed cpak version.
.P
.nf
.RS
cpak v
.RE
.fi
.TP
.B help
Get information about the help command.
.P
.nf
.RS
cpak h help
.RE
.fi
.TP
.B config
Generate the default cpak config and the default template.
.P
.nf
.RS
cpak c
.RE
.fi
.P
.nf
.RS
cpak c -f
.RE
.fi
.TP
.B bootstrap
Copies the content of the template
.B default
into the current directory and executes the
.B cpak_template.sh
file in the current directory.
.P
.nf
.RS
cpak b default
.RE
.fi
.TP
.B add
Install the module
.B xutils
from the Github user
.B xnacly.
.P
.nf
.RS
cpak a xnacly/xutils
.RE
.fi
.TP
.B remove
Remove the module
.B xutils.
.P
.nf
.RS
cpak r xutils
.RE
.fi
.TP
.B upgrade
Upgrade the module
.B xutils.
.P
.nf
.RS
cpak u xutils
.RE
.fi
.SH AUTHORS
Written by xnacly
.SH REPORTING BUGS
Cpak online documentation: <https://github.com/xnacly/c_paket>
Report bugs to: <https://github.com/xnacly/c_paket/issues/new>