Skip to content

Commit b9f2903

Browse files
committed
man: updating the rhc manual page and cleaning it up
1 parent d4f8389 commit b9f2903

File tree

1 file changed

+83
-19
lines changed

1 file changed

+83
-19
lines changed

man/rhc.1

Lines changed: 83 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,100 @@
11
.\" Process this file with
22
.\" groff -man -Tascii rhc.1
33
.\"
4-
.TH RHC 1 "JANUARY 2012" Linux "User Manuals"
4+
.TH RHC 1 "NOVEMBER 2013" Linux "User Manuals"
55
.SH NAME
6-
rhc \- Command line tool for performing operations related to your rhcloud account
6+
rhc \- Command line tool for performing operations related to your OpenShift account
77
.SH SYNOPSIS
88
.B rhc (<resource> | --help) [<command>] [<args>]
99

1010
.SH DESCRIPTION
1111
.B rhc
12-
Command line tool for performing operations related to your rhcloud account.
12+
Command line tool for performing operations related to your OpenShift account.
1313

1414
.SH LIST OF RESOURCES
15-
.IP domain
16-
Manage a domain in rhcloud for a registered rhcloud user
17-
.IP app
18-
Create and manage an OpenShift application
19-
.IP sshkey
20-
Manage multiple keys for the registered rhcloud user
21-
.IP port-forward
15+
.TP
16+
.PD 1
17+
.B account
18+
Display details about your account
19+
.TP
20+
.PD 1
21+
.B alias
22+
Add or remove a custom domain name for the application
23+
.TP
24+
.PD 1
25+
.B app
26+
Create and manage an application
27+
.TP
28+
.PD 1
29+
.B apps
30+
List all your applications
31+
.TP
32+
.PD 1
33+
.B authorization
34+
Show the authorization tokens for your account
35+
.TP
36+
.PD 1
37+
.B cartridge
38+
Manage your application cartridges
39+
.TP
40+
.PD 1
41+
.B deployment
42+
Manage your application's deployments
43+
.TP
44+
.PD 1
45+
.B domain
46+
Manage a domain for a registered user
47+
.TP
48+
.PD 1
49+
.B env
50+
Manage user-defined environment variables set on a given application
51+
.TP
52+
.PD 1
53+
.B git-clone
54+
Clone and configure an application's repository locally
55+
.TP
56+
.PD 1
57+
.B logout
58+
Logout from the current session
59+
.TP
60+
.PD 1
61+
.B member|members
62+
Manage membership on domains
63+
.TP
64+
.PD 1
65+
.B port-forward
2266
Forward remote ports to the workstation
23-
.IP setup
24-
Run the setup wizard to configure your account
25-
.IP server
67+
.TP
68+
.PD 1
69+
.B server
2670
Display information about the status of the service
27-
.IP tail
71+
.TP
72+
.PD 1
73+
.B setup
74+
Run the setup wizard to configure your account
75+
.TP
76+
.PD 1
77+
.B snapshot
78+
Manage applications snapshots
79+
.TP
80+
.PD 1
81+
.B ssh
82+
SSH into the specified application
83+
.TP
84+
.PD 1
85+
.B sshkey
86+
Manage multiple keys for the registered OpenShift user
87+
.TP
88+
.PD 1
89+
.B tail
2890
Tail files from remote running applications in real\-time
29-
.IP threaddump
91+
.TP
92+
.PD 1
93+
.B threaddump
3094
Trigger a thread dump for JBoss and Ruby applications
31-
.IP alias
32-
Add or remove a custom domain name for the application
33-
.IP \-h|\-\-help|help
95+
.TP
96+
.PD 1
97+
.B \-h|\-\-help|help
3498
Display help menu
3599

36100
.SH FILES
@@ -59,7 +123,7 @@ Forums: https://openshift.redhat.com/community/forums/openshift
59123
IRC: #openshift on irc.freenode.net
60124

61125
.SH AUTHOR
62-
Mike McGrath <[email protected]>, Jim Jagielski <[email protected]>
126+
Mike McGrath <[email protected]>, Jim Jagielski <[email protected]>, Marek Mahut <[email protected]>
63127

64128
.SH "SEE ALSO"
65129
.BR express.conf (5)

0 commit comments

Comments
 (0)