Browse code

Adding man page for ansible-galaxy

Partially resolves #6471

James Cammarata authored on 2014/03/17 03:58:42
Showing 3 changed files
... ...
@@ -20,7 +20,7 @@ OS = $(shell uname -s)
20 20
 # Manpages are currently built with asciidoc -- would like to move to markdown
21 21
 # This doesn't evaluate until it's called. The -D argument is the
22 22
 # directory of the target file ($@), kinda like `dirname`.
23
-MANPAGES := docs/man/man1/ansible.1 docs/man/man1/ansible-playbook.1 docs/man/man1/ansible-pull.1 docs/man/man1/ansible-doc.1
23
+MANPAGES := docs/man/man1/ansible.1 docs/man/man1/ansible-playbook.1 docs/man/man1/ansible-pull.1 docs/man/man1/ansible-doc.1 docs/man/man1/ansible-galaxy.1
24 24
 ifneq ($(shell which a2x 2>/dev/null),)
25 25
 ASCII2MAN = a2x -D $(dir $@) -d manpage -f manpage $<
26 26
 ASCII2HTMLMAN = a2x -D docs/html/man/ -d manpage -f xhtml
... ...
@@ -172,3 +172,4 @@ deb: debian
172 172
 webdocs: $(MANPAGES)
173 173
 	(cd docsite/; make docs)
174 174
 
175
+docs: $(MANPAGES)
175 176
new file mode 100644
... ...
@@ -0,0 +1,180 @@
0
+'\" t
1
+.\"     Title: ansible-galaxy
2
+.\"    Author: [see the "AUTHOR" section]
3
+.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
4
+.\"      Date: 03/16/2014
5
+.\"    Manual: System administration commands
6
+.\"    Source: Ansible 1.6
7
+.\"  Language: English
8
+.\"
9
+.TH "ANSIBLE\-GALAXY" "1" "03/16/2014" "Ansible 1\&.6" "System administration commands"
10
+.\" -----------------------------------------------------------------
11
+.\" * Define some portability stuff
12
+.\" -----------------------------------------------------------------
13
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14
+.\" http://bugs.debian.org/507673
15
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
16
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17
+.ie \n(.g .ds Aq \(aq
18
+.el       .ds Aq '
19
+.\" -----------------------------------------------------------------
20
+.\" * set default formatting
21
+.\" -----------------------------------------------------------------
22
+.\" disable hyphenation
23
+.nh
24
+.\" disable justification (adjust text to left margin only)
25
+.ad l
26
+.\" -----------------------------------------------------------------
27
+.\" * MAIN CONTENT STARTS HERE *
28
+.\" -----------------------------------------------------------------
29
+.SH "NAME"
30
+ansible-galaxy \- manage roles using galaxy\&.ansible\&.com
31
+.SH "SYNOPSIS"
32
+.sp
33
+ansible\-galaxy [init|info|install|list|remove] [\-\-help] [options] \&...
34
+.SH "DESCRIPTION"
35
+.sp
36
+\fBAnsible Galaxy\fR is a shared repository for Ansible roles (added in ansible version 1\&.2)\&. The ansible\-galaxy command can be used to manage these roles, or by creating a skeleton framework for roles you\(cqd like to upload to Galaxy\&.
37
+.SH "COMMON OPTIONS"
38
+.PP
39
+\fB\-h\fR, \fB\-\-help\fR
40
+.RS 4
41
+Show a help message related to the given sub\-command\&.
42
+.RE
43
+.SH "INSTALL"
44
+.sp
45
+The \fBinstall\fR sub\-command is used to install roles\&.
46
+.SS "USAGE"
47
+.sp
48
+$ ansible\-galaxy install [options] [\-r FILE | role_name(s)[,version] | tar_file(s)]
49
+.sp
50
+Roles can be installed in several different ways:
51
+.sp
52
+.RS 4
53
+.ie n \{\
54
+\h'-04'\(bu\h'+03'\c
55
+.\}
56
+.el \{\
57
+.sp -1
58
+.IP \(bu 2.3
59
+.\}
60
+A username\&.rolename[,version] \- this will install a single role\&. The Galaxy API will be contacted to provide the information about the role, and the corresponding \&.tar\&.gz will be downloaded from
61
+\fBgithub\&.com\fR\&. If the version is omitted, the most recent version available will be installed\&.
62
+.RE
63
+.sp
64
+.RS 4
65
+.ie n \{\
66
+\h'-04'\(bu\h'+03'\c
67
+.\}
68
+.el \{\
69
+.sp -1
70
+.IP \(bu 2.3
71
+.\}
72
+A file name, using
73
+\fB\-r\fR
74
+\- this will install multiple roles listed one per line\&. The format of each line is the same as above: username\&.rolename[,version]
75
+.RE
76
+.sp
77
+.RS 4
78
+.ie n \{\
79
+\h'-04'\(bu\h'+03'\c
80
+.\}
81
+.el \{\
82
+.sp -1
83
+.IP \(bu 2.3
84
+.\}
85
+A \&.tar\&.gz of a valid role you\(cqve downloaded directly from
86
+\fBgithub\&.com\fR\&. This is mainly useful when the system running Ansible does not have access to the Galaxy API, for instance when behind a firewall or proxy\&.
87
+.RE
88
+.SS "OPTIONS"
89
+.PP
90
+\fB\-f\fR, \fB\-\-force\fR
91
+.RS 4
92
+Force overwriting an existing role\&.
93
+.RE
94
+.PP
95
+\fB\-i\fR, \fB\-\-ignore\-errors\fR
96
+.RS 4
97
+Ignore errors and continue with the next specified role\&.
98
+.RE
99
+.PP
100
+\fB\-n\fR, \fB\-\-no\-deps\fR
101
+.RS 4
102
+Don\(cqt download roles listed as dependencies\&.
103
+.RE
104
+.PP
105
+\fB\-p\fR \fIROLES_PATH\fR, \fB\-\-roles\-path=\fR\fIROLES_PATH\fR
106
+.RS 4
107
+The path to the directory containing your roles\&. The default is the
108
+\fBroles_path\fR
109
+configured in your
110
+\fBansible\&.cfg\fR
111
+file (/etc/ansible/roles if not configured)
112
+.RE
113
+.PP
114
+\fB\-r\fR \fIROLE_FILE\fR, \fB\-\-role\-file=\fR\fIROLE_FILE\fR
115
+.RS 4
116
+A file containing a list of roles to be imported, as specified above\&. This option cannot be used if a rolename or \&.tar\&.gz have been specified\&.
117
+.RE
118
+.SH "REMOVE"
119
+.sp
120
+The \fBremove\fR sub\-command is used to remove one or more roles\&.
121
+.SS "USAGE"
122
+.sp
123
+$ ansible\-galaxy remove role1 role2 \&...
124
+.SS "OPTIONS"
125
+.PP
126
+\fB\-p\fR \fIROLES_PATH\fR, \fB\-\-roles\-path=\fR\fIROLES_PATH\fR
127
+.RS 4
128
+The path to the directory containing your roles\&. The default is the
129
+\fBroles_path\fR
130
+configured in your
131
+\fBansible\&.cfg\fR
132
+file (/etc/ansible/roles if not configured)
133
+.RE
134
+.SH "INIT"
135
+.sp
136
+The \fBinit\fR command is used to create an empty role suitable for uploading to https://galaxy\&.ansible\&.com (or for roles in general)\&.
137
+.SS "USAGE"
138
+.sp
139
+$ ansible\-galaxy init [options] role_name
140
+.SS "OPTIONS"
141
+.PP
142
+\fB\-f\fR, \fB\-\-force\fR
143
+.RS 4
144
+Force overwriting an existing role\&.
145
+.RE
146
+.PP
147
+\fB\-p\fR \fIINIT_PATH\fR, \fB\-\-init\-path=\fR\fIINIT_PATH\fR
148
+.RS 4
149
+The path in which the skeleton role will be created\&.The default is the current working directory\&.
150
+.RE
151
+.SH "LIST"
152
+.sp
153
+The \fBlist\fR sub\-command is used to show what roles are currently instaled\&. You can specify a role name, and if installed only that role will be shown\&.
154
+.SS "USAGE"
155
+.sp
156
+$ ansible\-galaxy list [role_name]
157
+.SS "OPTIONS"
158
+.PP
159
+\fB\-p\fR \fIROLES_PATH\fR, \fB\-\-roles\-path=\fR\fIROLES_PATH\fR
160
+.RS 4
161
+The path to the directory containing your roles\&. The default is the
162
+\fBroles_path\fR
163
+configured in your
164
+\fBansible\&.cfg\fR
165
+file (/etc/ansible/roles if not configured)
166
+.RE
167
+.SH "AUTHOR"
168
+.sp
169
+Ansible was originally written by Michael DeHaan\&. See the AUTHORS file for a complete list of contributors\&.
170
+.SH "COPYRIGHT"
171
+.sp
172
+Copyright \(co 2014, Michael DeHaan
173
+.sp
174
+Ansible is released under the terms of the GPLv3 License\&.
175
+.SH "SEE ALSO"
176
+.sp
177
+\fBansible\fR(1), \fBansible\-pull\fR(1), \fBansible\-doc\fR(1)
178
+.sp
179
+Extensive documentation is available in the documentation site: http://docs\&.ansible\&.com\&. IRC and mailing list info can be found in file CONTRIBUTING\&.md, available in: https://github\&.com/ansible/ansible
0 180
new file mode 100644
... ...
@@ -0,0 +1,167 @@
0
+ansible-galaxy(1)
1
+===================
2
+:doctype:      manpage
3
+:man source:   Ansible
4
+:man version:  %VERSION%
5
+:man manual:   System administration commands
6
+
7
+NAME
8
+----
9
+ansible-galaxy - manage roles using galaxy.ansible.com
10
+
11
+
12
+SYNOPSIS
13
+--------
14
+ansible-galaxy [init|info|install|list|remove] [--help] [options] ...
15
+
16
+
17
+DESCRIPTION
18
+-----------
19
+
20
+*Ansible Galaxy* is a shared repository for Ansible roles (added in
21
+ansible version 1.2). The ansible-galaxy command can be used to manage
22
+these roles, or by creating a skeleton framework for roles you'd like
23
+to upload to Galaxy.
24
+
25
+COMMON OPTIONS
26
+--------------
27
+
28
+*-h*, *--help*::
29
+
30
+Show a help message related to the given sub-command.
31
+
32
+
33
+INSTALL
34
+-------
35
+
36
+The *install* sub-command is used to install roles.
37
+
38
+USAGE
39
+~~~~~
40
+
41
+$ ansible-galaxy install [options] [-r FILE | role_name(s)[,version] | tar_file(s)]
42
+
43
+Roles can be installed in several different ways:
44
+
45
+* A username.rolename[,version] - this will install a single role. The Galaxy 
46
+  API will be contacted to provide the information about the role, and the 
47
+  corresponding .tar.gz will be downloaded from *github.com*. If the version 
48
+  is omitted, the most recent version available will be installed.
49
+
50
+* A file name, using *-r* - this will install multiple roles listed one per
51
+  line. The format of each line is the same as above: username.rolename[,version]
52
+
53
+* A .tar.gz of a valid role you've downloaded directly from *github.com*. This
54
+  is mainly useful when the system running Ansible does not have access to 
55
+  the Galaxy API, for instance when behind a firewall or proxy.
56
+
57
+
58
+OPTIONS
59
+~~~~~~~
60
+
61
+*-f*, *--force*::
62
+
63
+Force overwriting an existing role.
64
+
65
+*-i*, *--ignore-errors*::
66
+
67
+Ignore errors and continue with the next specified role.
68
+
69
+*-n*, *--no-deps*::
70
+
71
+Don't download roles listed as dependencies.
72
+
73
+*-p* 'ROLES_PATH', *--roles-path=*'ROLES_PATH'::
74
+
75
+The path to the directory containing your roles. The default is the *roles_path* 
76
+configured in your *ansible.cfg* file (/etc/ansible/roles if not configured)
77
+
78
+*-r* 'ROLE_FILE', *--role-file=*'ROLE_FILE'::
79
+
80
+A file containing a list of roles to be imported, as specified above. This
81
+option cannot be used if a rolename or .tar.gz have been specified.
82
+
83
+REMOVE
84
+------
85
+
86
+The *remove* sub-command is used to remove one or more roles.
87
+
88
+USAGE
89
+~~~~~
90
+
91
+$ ansible-galaxy remove role1 role2 ...
92
+
93
+OPTIONS
94
+~~~~~~~
95
+
96
+*-p* 'ROLES_PATH', *--roles-path=*'ROLES_PATH'::
97
+
98
+The path to the directory containing your roles. The default is the *roles_path* 
99
+configured in your *ansible.cfg* file (/etc/ansible/roles if not configured)
100
+
101
+INIT
102
+----
103
+
104
+The *init* command is used to create an empty role suitable for uploading
105
+to https://galaxy.ansible.com (or for roles in general).
106
+
107
+USAGE
108
+~~~~~
109
+
110
+$ ansible-galaxy init [options] role_name
111
+
112
+OPTIONS
113
+~~~~~~~
114
+
115
+*-f*, *--force*::
116
+
117
+Force overwriting an existing role.
118
+
119
+*-p* 'INIT_PATH', *--init-path=*'INIT_PATH'::
120
+
121
+The path in which the skeleton role will be created.The default is the current 
122
+working directory.
123
+
124
+LIST
125
+----
126
+
127
+The *list* sub-command is used to show what roles are currently instaled.
128
+You can specify a role name, and if installed only that role will be shown.
129
+
130
+USAGE
131
+~~~~~
132
+
133
+$ ansible-galaxy list [role_name]
134
+
135
+OPTIONS
136
+~~~~~~~
137
+
138
+*-p* 'ROLES_PATH', *--roles-path=*'ROLES_PATH'::
139
+
140
+The path to the directory containing your roles. The default is the *roles_path*
141
+configured in your *ansible.cfg* file (/etc/ansible/roles if not configured)
142
+
143
+
144
+AUTHOR
145
+------
146
+
147
+Ansible was originally written by Michael DeHaan. See the AUTHORS file
148
+for a complete list of contributors.
149
+
150
+
151
+COPYRIGHT
152
+---------
153
+
154
+Copyright © 2014, Michael DeHaan
155
+
156
+Ansible is released under the terms of the GPLv3 License.
157
+
158
+
159
+SEE ALSO
160
+--------
161
+
162
+*ansible*(1), *ansible-pull*(1), *ansible-doc*(1)
163
+
164
+Extensive documentation is available in the documentation site:
165
+<http://docs.ansible.com>. IRC and mailing list info can be found
166
+in file CONTRIBUTING.md, available in: <https://github.com/ansible/ansible>