Add configuration file info to the man page
authorEd Bartosh <eduard.bartosh@intel.com>
Sat, 29 Mar 2014 23:12:15 +0000 (01:12 +0200)
committerEd Bartosh <eduard.bartosh@intel.com>
Tue, 1 Apr 2014 08:11:05 +0000 (11:11 +0300)
Fixes: #1764
Change-Id: I62d75e44aac796605c23cfc5ad9820e44b55de9d
Signed-off-by: Ed Bartosh <eduard.bartosh@intel.com>
repa.1

diff --git a/repa.1 b/repa.1
index f16cb9b2842af46e91c3522c42f37f02a32b51ba..40bd2e01b3973bb51ceffbfe34074f00e9865eff 100644 (file)
--- a/repa.1
+++ b/repa.1
@@ -285,6 +285,43 @@ Remove submit group.
 Print short help text about the "rmgroup" command and exit.
 .RE
 
+.SH CONFIGURATION FILE
+
+.RS 2
+Configuration file has an INI-file syntax. \fIrepa\fR looks for config files in two locations: global /etc/repa.conf and local ~/.repa.conf. Values from global configuration file are overwritten by values from local configuration file. Command line options have highest priority and overwrite options from configuration files.
+.RE
+
+.RS 2
+Example:
+.RE
+
+.RS 2
+[general]
+.RE
+.RS 2
+apiurl = https://api.tizen.org
+.RE
+.RS 2
+apiuser = your_user_name
+.RE
+.RS 2
+apipasswd = your_password
+.RE
+.RS 2
+processes = 20
+.RE
+.RS 2
+project = Tizen:IVI
+.RE
+
+.RS 2
+Mandatory options: apiurl, apiuser, apipasswd and project
+.RE
+
+.RS 2
+Some options (project, processes) can be overridden by commandline options (--project, --processes)
+.RE
+
 .SH BUGS
 Please, report bugs to Ed Bartosh <eduard.bartosh@intel.com>.