adding docs directoryv1.0_rc1

2 files changed, 64 insertions, 1 deletions

diff --git a/docs/man/setup-box.1 b/docs/man/setup-box.1
new file mode 100644
index 0000000..be3f89e
--- /dev/null
+++ b/docs/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
diff --git a/setup-box b/setup-box
index bf0448d..e1c567c 100755
--- a/setup-box
+++ b/setup-box
@@ -209,7 +209,7 @@ EOF
 		|| echo "psmouse" >> /etc/modules
 }
 
-# Called by -L option
+# Called by -G option
 list_meta_groups() {
    cat <<__EOF__
 $(basename $0) $VERSION
@@ -223,6 +223,7 @@ __EOF__
 	exit 1
 }
 
+# Called by -S option
 list_sub_groups() {
    cat <<__EOF__
 $(basename $0) $VERSION