summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlan Lacerda <alacerda@alpinelinux.org>2015-07-01 18:16:24 +0000
committerAlan Lacerda <alacerda@alpinelinux.org>2015-07-01 18:16:24 +0000
commitb17c70003f9e57a9079ab8e00e6ffdb3b6208cda (patch)
treef04e3a00540923d946e9f4b0f907abe946d95df8
parent9b025ffe04cfeea804d8caa01cc8a22a3bf720d8 (diff)
downloadsetup-box-b17c70003f9e57a9079ab8e00e6ffdb3b6208cda.tar.bz2
setup-box-b17c70003f9e57a9079ab8e00e6ffdb3b6208cda.tar.xz
documentation: fixed typo
-rw-r--r--usr/share/man/setup-box.162
-rw-r--r--usr/share/man/setup-box.1.gzbin860 -> 0 bytes
2 files changed, 62 insertions, 0 deletions
diff --git a/usr/share/man/setup-box.1 b/usr/share/man/setup-box.1
new file mode 100644
index 0000000..6fc7302
--- /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 desktops 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
diff --git a/usr/share/man/setup-box.1.gz b/usr/share/man/setup-box.1.gz
deleted file mode 100644
index 9362b11..0000000
--- a/usr/share/man/setup-box.1.gz
+++ /dev/null
Binary files differ