[copr] master: add man page for copr-cli (8819d78)

msuchy at fedoraproject.org msuchy at fedoraproject.org
Mon Jun 17 12:52:38 UTC 2013


Repository : http://git.fedorahosted.org/cgit/copr.git

On branch  : master

>---------------------------------------------------------------

commit 8819d78d5d3f89b3d940365560c9e1c3eb90b588
Author: Miroslav Suchý <msuchy at redhat.com>
Date:   Fri Jun 14 15:51:07 2013 +0200

    add man page for copr-cli


>---------------------------------------------------------------

 copr.spec               |   12 ++++++
 man/copr-cli.1.asciidoc |   89 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 101 insertions(+), 0 deletions(-)

diff --git a/copr.spec b/copr.spec
index 29a5efb..10d066f 100644
--- a/copr.spec
+++ b/copr.spec
@@ -8,6 +8,10 @@ License:	GPLv2+
 URL:		https://fedorahosted.org/copr/
 Source0:	%{name}-%{version}.tar.gz
 
+BuildRequires: asciidoc
+BuildRequires: libxslt
+BuildRequires: util-linux
+
 %description
 COPR is lightway Koji. It allows you to create new project in WebUI, and
 submit new builds and COPR will create yum repository from latests builds.
@@ -74,9 +78,15 @@ This package contains command line interface.
 %build
 mv copr_cli/README.rst ./
 
+# convert manages
+a2x -d manpage -f manpage man/copr-cli.1.asciidoc
+
 %install
 %{__python} coprcli-setup.py install --root %{buildroot}
 
+install -d %{buildroot}%{_mandir}/man1
+install -m 644 man/copr-cli.1 %{buildroot}/%{_mandir}/man1/
+
 %pre backend
 getent group copr >/dev/null || groupadd -r copr
 getent passwd copr >/dev/null || \
@@ -93,5 +103,7 @@ useradd -r -g copr -G apache -d %{_var}/lib/copr -s /bin/bash -c "COPR user" cop
 %doc LICENSE README.rst
 %{_bindir}/copr-cli
 %{python_sitelib}/*
+%doc %{_mandir}/man1/copr-cli.1*
 
 %changelog
+
diff --git a/man/copr-cli.1.asciidoc b/man/copr-cli.1.asciidoc
new file mode 100644
index 0000000..b04ccf6
--- /dev/null
+++ b/man/copr-cli.1.asciidoc
@@ -0,0 +1,89 @@
+copr-cli(1)
+==========
+:man source:  copr
+:man manual:  COPR
+
+NAME
+----
+copr-cli - command line interface for COPR
+
+
+SYNOPSIS
+--------
+copr-cli [-h] [--version] {list,create,build} ...
+
+DESCRIPTION
+-----------
+
+This command allow you to interact with build system COPR from command line.
+
+OPTIONS
+-------
+
+-h, --help::
+show this help message and exit
+
+--version::
+show program's version number and exit
+
+ACTIONS
+-------
+
+list [username]::
+List all the copr of the provided username. If no username is provided,
+then your coprs are listed.
+
+create::
+Create a new copr.
+
+build ::
+Build packages to a specified copr.
+
+
+`copr-cli create [options]`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+usage: copr-cli create [-h] [--chroot CHROOTS] [--repo REPOS]
+                       [--initial-pkgs INITIAL_PKGS]
+                       [--description DESCRIPTION]
+                       [--instructions INSTRUCTIONS]
+                       name
+
+--chroot::
+Chroot to use for this copr. Can be specified multiple times.
+
+--repo::
+Repository to add to this copr. Can be specified multiple times.
+
+--initial-pkgs::
+List of packages to build in this new copr. Can be specified multiple times.
+
+--description::
+Description of the copr.
+
+--instructions::
+Instructions for the copr.
+
+
+`copr-cli build [options]`
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+usage: copr-cli build [-h] [--memory MEMORY] [--timeout TIMEOUT]
+                      copr pkgs [pkgs ...]
+
+--memory::
+TBD
+
+--timeout::
+TBD
+
+copr::
+The copr repo to build the package in
+
+pkgs::
+Package to build.
+
+
+AUTHORS
+-------
+Miroslav Suchý <msuchy at redhat.com>



More information about the copr-devel mailing list