[PATCH 3/5] Add a man page for copr-cli

Pierre-Yves Chibon pingou at pingoured.fr
Wed Nov 27 19:42:06 UTC 2013


---
 copr_cli/copr-cli.1 | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 copr_cli/copr-cli.1

diff --git a/copr_cli/copr-cli.1 b/copr_cli/copr-cli.1
new file mode 100644
index 0000000..f5f378f
--- /dev/null
+++ b/copr_cli/copr-cli.1
@@ -0,0 +1,70 @@
+.TH "copr-cli" 1
+.SH NAME
+copr-cli \- A command line interface to COPR.
+
+.SH SYNOPSIS
+.B copr-cli
+list [user name]
+.br
+.B copr-cli
+create <name>
+.br
+.B copr-cli
+build <copr> <url to srpm>
+
+.SH DESCRIPTION
+
+This tools allows using copr from the command line rather than going onto
+the web application.
+
+.SH USAGE
+.HP
+copr-cli list [user name]
+
+It will return you the list and information of all the COPR made by the
+specified user. If no user is precised it will rely on the configuration
+file to extract your username and will return all your COPR.
+
+.HP
+copr-cli create [copr name]
+
+This will create a new COPR with the specified name. It will rely on the
+presence of the configuration file to extract your authentication
+information.
+
+.HP
+copr-cli build [copr name] [url to srpm]
+
+This will build the provided srpm into the specified COPR. It will rely on
+the presence of the configuration file to extract your authentication
+information.
+
+
+.SH OPTIONS
+.B -h / --help
+    Displays the generic help message or specific to an action.
+.sp
+.B -v / --version
+    Displays the version of copr-cli.
+.sp
+
+.SH CONFIGURATION
+.I $HOME/.conf/copr
+.RS
+In this configuration file, you may enter your authentication information.
+These information contain the username and API token that can be used to
+identify you to the COPR API and allow copr-cli to work as expected.
+.PP
+Your configuration file should look like:
+.IP "" 4
+ [copr-cli]
+ username = <insert here your API login>
+ token = <insert here your API token>
+.RE
+
+.SH AUTHORS
+  Pierre-Yves Chibon <pingou at pingoured.fr>
+
+.sp
+.sp
+No known bugs at this time
-- 
1.8.3.1



More information about the copr-devel mailing list