[DRE-commits] [rhc] 18/22: Add manpages

Chow Loong Jin hyperair at debian.org
Fri Oct 3 16:48:42 UTC 2014 

This is an automated email from the git hooks/post-receive script.

hyperair pushed a commit to branch master
in repository rhc.

commit 04dd482804197dc4b16e7523429fca26af1b594d
Author: Chow Loong Jin <hyperair at debian.org>
Date:   Fri Oct 3 14:51:18 2014 +0800

    Add manpages
---
 debian/man/express.conf.5 |  86 +++++++++++++++++++++++++++++++
 debian/man/rhc.1          | 129 ++++++++++++++++++++++++++++++++++++++++++++++
 debian/rhc.manpages       |   2 +
 3 files changed, 217 insertions(+)

diff --git a/debian/man/express.conf.5 b/debian/man/express.conf.5
new file mode 100644
index 0000000..a2b4661
--- /dev/null
+++ b/debian/man/express.conf.5
@@ -0,0 +1,86 @@
+.\" Process this file with
+.\" groff -man -Tascii express.conf.5
+.\" 
+.TH "express.conf" "5" "JANUARY 2011" "Linux" "User Manuals"
+.SH "NAME"
+express.conf \- configuration file for OpenShift
+.SH "SYNOPSIS"
+Search order (on a per variable basis):
+
+1) ~/.openshift/express.conf (Created on first usage of rhc client tools and can be customized per system user)
+
+2) /etc/openshift/express.conf (RPM install path)
+
+3) <ruby_gem_dir>/gems/rhc\-<version>/conf/express.conf (RubyGem install path)
+.SH "DESCRIPTION"
+.B express.conf
+contains the following configuration params:
+
+.I libra_server
+The server the rhc client tools communicate with i.e. 
+.B https://openshift.redhat.com
+
+.I ssh_key_file
+The name of the rsa key file used with your OpenShift applications.  File
+should exist under ~/.ssh along with corresponding <ssh_key_file>.pub (Can
+also be specified as a full path).  The defaults if not specified are
+libra_id_rsa followed by id_rsa.  Ex:
+.B libra_id_rsa
+Note: If you set this value after creating your domain you'll need to run
+.B rhc\-create\-domain \-l <rhlogin> \-n <namespace> \-\-alter
+to update the corresponding key in OpenShift.  You'll also want to 
+modify the value of IdentityFile in your ~/.ssh/config file 
+for the *.rhcloud.com host.
+
+
+.I debug
+Boolean indicating whether debug should always be enabled for the rhc client tools.
+
+.I timeout
+Number of seconds before remote operations will timeout.
+
+.I default_rhlogin
+The default rhc client tools rhlogin.  Used as the default when the \-l argument is not passed to each of the client tools.
+
+.SH "FILES"
+.I <ruby_gem_dir>/gems/rhc\-<version>/conf/express.conf
+.RS
+The RubyGem system wide configuration file.
+.RE
+.I /etc/openshift/express.conf
+.RS
+The system wide configuration file.
+.RE
+.I ~/.openshift/express.conf
+.RS
+Per user configuration file.
+.RE
+.I ~/.ssh/config
+.RS
+SSH Config file is altered automatically to create support for
+newly created OpenShift hosts.  Should be harmless.  See
+.BR ssh_config (5)
+for more information.
+.RE
+.I ~/.ssh/libra_id_rsa
+.RS
+SSH key created by rhc\-create\-domain to interact with OpenShift services
+see
+.BR ssh\-keygen (1)
+for more information
+.RE
+.SH "BUGS"
+Please contact the Red Hat OpenShift team.
+Forums: https://openshift.redhat.com/community/forums/openshift
+IRC: #openshift on irc.freenode.net
+.SH "AUTHOR"
+Mike McGrath <mmcgrath at redhat.com>, Jim Jagielski <jimjag at redhat.com>
+.SH "SEE ALSO"
+.BR rhc\-create\-domain (1),
+.BR rhc\-ctl\-app (1),
+.BR rhc\-snapshot(1),
+.BR rhc\-user\-info(1),
+.BR rhc\-tail\-files (1),
+.BR rhc\-create\-app (1),
+.BR rhc\-port\-forward(1)
+
diff --git a/debian/man/rhc.1 b/debian/man/rhc.1
new file mode 100644
index 0000000..dbecc10
--- /dev/null
+++ b/debian/man/rhc.1
@@ -0,0 +1,129 @@
+.\" Process this file with
+.\" groff -man -Tascii rhc.1
+.\"
+.TH RHC 1 "NOVEMBER 2013" Linux "User Manuals"
+.SH NAME
+rhc \- Command line tool for performing operations related to your OpenShift account
+.SH SYNOPSIS
+.B rhc (<resource> | --help) [<command>] [<args>]
+
+.SH DESCRIPTION
+.B rhc
+Command line tool for performing operations related to your OpenShift account.
+
+.SH LIST OF RESOURCES
+.TP
+.PD 1
+.B account
+Display details about your account
+.TP
+.PD 1
+.B alias
+Add or remove a custom domain name for the application
+.TP
+.PD 1
+.B app
+Create and manage an application
+.TP
+.PD 1
+.B apps
+List all your applications
+.TP
+.PD 1
+.B authorization
+Show the authorization tokens for your account
+.TP
+.PD 1
+.B cartridge
+Manage your application cartridges
+.TP
+.PD 1
+.B deployment
+Manage your application's deployments
+.TP
+.PD 1
+.B domain
+Manage a domain for a registered user
+.TP
+.PD 1
+.B env
+Manage user-defined environment variables set on a given application
+.TP
+.PD 1
+.B git-clone
+Clone and configure an application's repository locally
+.TP
+.PD 1
+.B logout
+Logout from the current session
+.TP
+.PD 1
+.B member|members
+Manage membership on domains
+.TP
+.PD 1
+.B port-forward
+Forward remote ports to the workstation
+.TP
+.PD 1
+.B server
+Display information about the status of the service
+.TP
+.PD 1
+.B setup
+Run the setup wizard to configure your account
+.TP
+.PD 1
+.B snapshot
+Manage applications snapshots
+.TP
+.PD 1
+.B ssh
+SSH into the specified application
+.TP
+.PD 1
+.B sshkey
+Manage multiple keys for the registered OpenShift user
+.TP
+.PD 1
+.B tail
+Tail files from remote running applications in real\-time
+.TP
+.PD 1
+.B threaddump
+Trigger a thread dump for JBoss and Ruby applications
+.TP
+.PD 1
+.B \-h|\-\-help|help
+Display help menu
+
+.SH FILES
+.I <ruby_gem_dir>/gems/rhc-<version>/conf/express.conf
+.RS
+The RubyGem system wide configuration file. See
+.BR express.conf (5)
+for further details.
+.RE
+.I /etc/openshift/express.conf
+.RS
+The system wide configuration file. See
+.BR express.conf (5)
+for further details.
+.RE
+.I ~/.openshift/express.conf
+.RS
+Per user configuration file. See
+.BR express.conf (5)
+for further details.
+.RE
+
+.SH BUGS
+Please contact the Red Hat OpenShift team.
+Forums: https://openshift.redhat.com/community/forums/openshift
+IRC: #openshift on irc.freenode.net
+
+.SH AUTHOR
+Mike McGrath <mmcgrath at redhat.com>, Jim Jagielski <jimjag at redhat.com>, Marek Mahut <mmahut at redhat.com>
+
+.SH "SEE ALSO"
+.BR express.conf (5)
diff --git a/debian/rhc.manpages b/debian/rhc.manpages
new file mode 100644
index 0000000..d47ba24
--- /dev/null
+++ b/debian/rhc.manpages
@@ -0,0 +1,2 @@
+debian/man/express.conf.5
+debian/man/rhc.1

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/rhc.git

More information about the Pkg-ruby-extras-commits mailing list