diff options
| author | Alan Lacerda <alacerda@alpinelinux.org> | 2015-06-23 13:53:40 +0000 |
|---|---|---|
| committer | Alan Lacerda <alacerda@alpinelinux.org> | 2015-06-23 13:53:40 +0000 |
| commit | 89bc777ab4d2917d16369cf30d0f93989e6348eb (patch) | |
| tree | bef00056fc7beada54e7780e23b7bf80d7ff4363 /usr | |
| parent | 91189d9a699a5845e69d57fdd4c6edef41e9aaa7 (diff) | |
| download | setup-box-89bc777ab4d2917d16369cf30d0f93989e6348eb.tar.bz2 setup-box-89bc777ab4d2917d16369cf30d0f93989e6348eb.tar.xz | |
documentationv1.0_rc5
Diffstat (limited to 'usr')
| -rw-r--r-- | usr/share/man/Makefile | 6 | ||||
| -rw-r--r-- | usr/share/man/setup-box.1 | 62 |
2 files changed, 68 insertions, 0 deletions
diff --git a/usr/share/man/Makefile b/usr/share/man/Makefile new file mode 100644 index 0000000..4f5f256 --- /dev/null +++ b/usr/share/man/Makefile @@ -0,0 +1,6 @@ +MAN1PAGES = setup-box.1 + +install: + $(INSTALLDIR) $(DESTDIR)$(MANDIR)/man1 + $(INSTALL) $(addprefix $(src)/,$(MAN1PAGES)) $(DESTDIR)$(MANDIR)/man1 + diff --git a/usr/share/man/setup-box.1 b/usr/share/man/setup-box.1 new file mode 100644 index 0000000..be3f89e --- /dev/null +++ b/usr/share/man/setup-box.1 @@ -0,0 +1,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 |