summaryrefslogtreecommitdiffstats
path: root/usr/share/man/setup-box.1
blob: be3f89e62d56bb4694b7ddf3c0f1c75bf7206c98 (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
53
54
55
56
57
58
59
60
61
62
.\" Manpage for setup-box.
.\" Contact alacerda@alpinelinux.org to correct errors or typos.
.TH man 1 "18 Jun 2015" "1.0" "setup-box man page"

.SH "NAME"
setup\-box \- setup a variety of Alpine Linux Environments

.SH "SYNOPSIS"
setup\-box option [args]

.SH "DESCRIPTION"
Based on a predefined list of packages setup-box sets up a desired environment for the user. It is also possible to create your own customized environment by edit or create a proper .json file located at /etc/setup-box/json.

You must run setup-box as root considering that it is going to install some packages.

.SH OPTIONS
\-d 
  Select one of the supported desktop environment (see DESKTOPS). -u is an useful option related to this.

\-u 
  Create a user with the choosen username. If -d was set but -u was not, a default user will be created. This option is valid just in case of -d being passed.

\-g
  Define a group to install (see -G)

\-s
  Define a subgroup to install (see -S)

\-h
  Show help

\-G
  List all avaliable groups

\-S
  List all avaliable subgroups

\-v
  Show any error - just in case

\-V
  Show setup-box version

.SH "DESKTOPS"
The following dessktops environments are avaliable: mate, openbox, xfce

.SH "EXAMPLES"
Installing MATE Desktop for Jane with Internet applications and Pentest tools:
   ~# setup-box -d mate -u jane -s desktop_extras.internet -g pentest

Installing a basic environment with Gparted:
   ~# setup-box -d openbox -s systools.disk


.SH "REPORTING BUGS"
Report bugs to the author

.SH "AUTHOR"
Alan Lacerda <alacerda@alpinelinux.org>

.SH "SEE ALSO"
setup-alpine