diff options
Diffstat (limited to 'docs/man')
| -rw-r--r-- | docs/man/.gitignore | 2 | ||||
| -rw-r--r-- | docs/man/man1/ansible-config.1 | 203 | ||||
| -rw-r--r-- | docs/man/man1/ansible-console.1 | 355 | ||||
| -rw-r--r-- | docs/man/man1/ansible-doc.1 | 188 | ||||
| -rw-r--r-- | docs/man/man1/ansible-galaxy.1 | 108 | ||||
| -rw-r--r-- | docs/man/man1/ansible-inventory.1 | 220 | ||||
| -rw-r--r-- | docs/man/man1/ansible-playbook.1 | 366 | ||||
| -rw-r--r-- | docs/man/man1/ansible-pull.1 | 391 | ||||
| -rw-r--r-- | docs/man/man1/ansible-vault.1 | 378 | ||||
| -rw-r--r-- | docs/man/man1/ansible.1 | 364 | ||||
| -rw-r--r-- | docs/man/man3/.gitdir | 0 |
11 files changed, 2575 insertions, 0 deletions
diff --git a/docs/man/.gitignore b/docs/man/.gitignore new file mode 100644 index 0000000..81a3367 --- /dev/null +++ b/docs/man/.gitignore @@ -0,0 +1,2 @@ +*.xml +*.asciidoc diff --git a/docs/man/man1/ansible-config.1 b/docs/man/man1/ansible-config.1 new file mode 100644 index 0000000..28b88cd --- /dev/null +++ b/docs/man/man1/ansible-config.1 @@ -0,0 +1,203 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "ANSIBLE-CONFIG" 1 "" "Ansible 2.14.3" "System administration commands" +.SH NAME +ansible-config \- View ansible configuration. +.SH SYNOPSIS +.sp +usage: ansible\-config [\-h] [\-\-version] [\-v] {list,dump,view,init} ... +.SH DESCRIPTION +.sp +Config command line class +.SH COMMON OPTIONS +.sp +\fB\-\-version\fP +.INDENT 0.0 +.INDENT 3.5 +show program\(aqs version number, config file location, configured module search path, module location, executable location and exit +.UNINDENT +.UNINDENT +.sp +\fB\-h\fP, \fB\-\-help\fP +.INDENT 0.0 +.INDENT 3.5 +show this help message and exit +.UNINDENT +.UNINDENT +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.INDENT 0.0 +.INDENT 3.5 +Causes Ansible to print more debug messages. Adding multiple \-v will increase the verbosity, the builtin plugins currently evaluate up to \-vvvvvv. A reasonable level to start is \-vvv, connection debugging might require \-vvvv. +.UNINDENT +.UNINDENT +.SH ACTIONS +.INDENT 0.0 +.TP +.B \fBlist\fP +list and output available configs +.sp +\fB\-\-format\fP \(aqFORMAT\(aq, \fB\-f\fP \(aqFORMAT\(aq +.INDENT 7.0 +.INDENT 3.5 +Output format for list +.UNINDENT +.UNINDENT +.sp +\fB\-c\fP \(aqCONFIG_FILE\(aq, \fB\-\-config\fP \(aqCONFIG_FILE\(aq +.INDENT 7.0 +.INDENT 3.5 +path to configuration file, defaults to first file found in precedence. +.UNINDENT +.UNINDENT +.sp +\fB\-t\fP \(aqTYPE\(aq, \fB\-\-type\fP \(aqTYPE\(aq +.INDENT 7.0 +.INDENT 3.5 +Filter down to a specific plugin type. +.UNINDENT +.UNINDENT +.TP +.B \fBdump\fP +Shows the current settings, merges ansible.cfg if specified +.sp +\fB\-\-format\fP \(aqFORMAT\(aq, \fB\-f\fP \(aqFORMAT\(aq +.INDENT 7.0 +.INDENT 3.5 +Output format for dump +.UNINDENT +.UNINDENT +.sp +\fB\-\-only\-changed\fP, \fB\-\-changed\-only\fP +.INDENT 7.0 +.INDENT 3.5 +Only show configurations that have changed from the default +.UNINDENT +.UNINDENT +.sp +\fB\-c\fP \(aqCONFIG_FILE\(aq, \fB\-\-config\fP \(aqCONFIG_FILE\(aq +.INDENT 7.0 +.INDENT 3.5 +path to configuration file, defaults to first file found in precedence. +.UNINDENT +.UNINDENT +.sp +\fB\-t\fP \(aqTYPE\(aq, \fB\-\-type\fP \(aqTYPE\(aq +.INDENT 7.0 +.INDENT 3.5 +Filter down to a specific plugin type. +.UNINDENT +.UNINDENT +.TP +.B \fBview\fP +Displays the current config file +.sp +\fB\-c\fP \(aqCONFIG_FILE\(aq, \fB\-\-config\fP \(aqCONFIG_FILE\(aq +.INDENT 7.0 +.INDENT 3.5 +path to configuration file, defaults to first file found in precedence. +.UNINDENT +.UNINDENT +.sp +\fB\-t\fP \(aqTYPE\(aq, \fB\-\-type\fP \(aqTYPE\(aq +.INDENT 7.0 +.INDENT 3.5 +Filter down to a specific plugin type. +.UNINDENT +.UNINDENT +.UNINDENT +.sp +\fBinit\fP +.INDENT 0.0 +.INDENT 3.5 +\fB\-\-disabled\fP +.INDENT 0.0 +.INDENT 3.5 +Prefixes all entries with a comment character to disable them +.UNINDENT +.UNINDENT +.sp +\fB\-\-format\fP \(aqFORMAT\(aq, \fB\-f\fP \(aqFORMAT\(aq +.INDENT 0.0 +.INDENT 3.5 +Output format for init +.UNINDENT +.UNINDENT +.sp +\fB\-c\fP \(aqCONFIG_FILE\(aq, \fB\-\-config\fP \(aqCONFIG_FILE\(aq +.INDENT 0.0 +.INDENT 3.5 +path to configuration file, defaults to first file found in precedence. +.UNINDENT +.UNINDENT +.sp +\fB\-t\fP \(aqTYPE\(aq, \fB\-\-type\fP \(aqTYPE\(aq +.INDENT 0.0 +.INDENT 3.5 +Filter down to a specific plugin type. +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SH ENVIRONMENT +.sp +The following environment variables may be specified. +.sp +ANSIBLE_CONFIG \-\- Specify override location for the ansible config file +.sp +Many more are available for most options in ansible.cfg +.sp +For a full list check \fI\%https://docs.ansible.com/\fP\&. or use the \fIansible\-config\fP command. +.SH FILES +.sp +/etc/ansible/ansible.cfg \-\- Config file, used if present +.sp +~/.ansible.cfg \-\- User config file, overrides the default config if present +.sp +\&./ansible.cfg \-\- Local config file (in current working directory) assumed to be \(aqproject specific\(aq and overrides the rest if present. +.sp +As mentioned above, the ANSIBLE_CONFIG environment variable will override all others. +.SH AUTHOR +.sp +Ansible was originally written by Michael DeHaan. +.SH COPYRIGHT +.sp +Copyright © 2018 Red Hat, Inc | Ansible. +Ansible is released under the terms of the GPLv3 license. +.SH SEE ALSO +.sp +\fBansible\fP (1), \fBansible\-console\fP (1), \fBansible\-doc\fP (1), \fBansible\-galaxy\fP (1), \fBansible\-inventory\fP (1), \fBansible\-playbook\fP (1), \fBansible\-pull\fP (1), \fBansible\-vault\fP (1) +.sp +Extensive documentation is available in the documentation site: +<\fI\%https://docs.ansible.com\fP>. +IRC and mailing list info can be found in file CONTRIBUTING.md, +available in: <\fI\%https://github.com/ansible/ansible\fP> +.\" Generated by docutils manpage writer. +. diff --git a/docs/man/man1/ansible-console.1 b/docs/man/man1/ansible-console.1 new file mode 100644 index 0000000..039959b --- /dev/null +++ b/docs/man/man1/ansible-console.1 @@ -0,0 +1,355 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "ANSIBLE-CONSOLE" 1 "" "Ansible 2.14.3" "System administration commands" +.SH NAME +ansible-console \- REPL console for executing Ansible tasks. +.SH SYNOPSIS +.INDENT 0.0 +.TP +.B usage: ansible\-console [\-h] [\-\-version] [\-v] [\-b] +[\-\-become\-method BECOME_METHOD] +[\-\-become\-user BECOME_USER] +[\-K | \-\-become\-password\-file BECOME_PASSWORD_FILE] +[\-i INVENTORY] [\-\-list\-hosts] [\-l SUBSET] +[\-\-private\-key PRIVATE_KEY_FILE] [\-u REMOTE_USER] +[\-c CONNECTION] [\-T TIMEOUT] +[\-\-ssh\-common\-args SSH_COMMON_ARGS] +[\-\-sftp\-extra\-args SFTP_EXTRA_ARGS] +[\-\-scp\-extra\-args SCP_EXTRA_ARGS] +[\-\-ssh\-extra\-args SSH_EXTRA_ARGS] +[\-k | \-\-connection\-password\-file CONNECTION_PASSWORD_FILE] +[\-C] [\-\-syntax\-check] [\-D] [\-\-vault\-id VAULT_IDS] +[\-\-ask\-vault\-password | \-\-vault\-password\-file VAULT_PASSWORD_FILES] +[\-f FORKS] [\-M MODULE_PATH] [\-\-playbook\-dir BASEDIR] +[\-e EXTRA_VARS] [\-\-task\-timeout TASK_TIMEOUT] [\-\-step] +[pattern] +.UNINDENT +.SH DESCRIPTION +.sp +A REPL that allows for running ad\-hoc tasks against a chosen inventory +from a nice shell with built\-in tab completion (based on dominis\(aq +ansible\-shell). +.sp +It supports several commands, and you can modify its configuration at +runtime: +.INDENT 0.0 +.IP \(bu 2 +\fIcd [pattern]\fP: change host/group (you can use host patterns eg.: +.UNINDENT +.IP "System Message: WARNING/2 (docs/man/man1/ansible-console.1.rst:, line 46)" +Bullet list ends without a blank line; unexpected unindent. +.sp +app*.dc*:!app01*) +\- \fIlist\fP: list available hosts in the current path +\- \fIlist groups\fP: list groups included in the current path +\- \fIbecome\fP: toggle the become flag +\- \fI!\fP: forces shell module instead of the ansible module (!yum update \-y) +\- \fIverbosity [num]\fP: set the verbosity level +\- \fIforks [num]\fP: set the number of forks +\- \fIbecome_user [user]\fP: set the become_user +\- \fIremote_user [user]\fP: set the remote_user +\- \fIbecome_method [method]\fP: set the privilege escalation method +\- \fIcheck [bool]\fP: toggle check mode +\- \fIdiff [bool]\fP: toggle diff mode +\- \fItimeout [integer]\fP: set the timeout of tasks in seconds (0 to disable) +\- \fIhelp [command/module]\fP: display documentation for the command or module +\- \fIexit\fP: exit ansible\-console +.SH COMMON OPTIONS +.INDENT 0.0 +.INDENT 3.5 +host pattern +.UNINDENT +.UNINDENT +.sp +\fB\-\-ask\-vault\-password\fP, \fB\-\-ask\-vault\-pass\fP +.INDENT 0.0 +.INDENT 3.5 +ask for vault password +.UNINDENT +.UNINDENT +.sp +\fB\-\-become\-method\fP \(aqBECOME_METHOD\(aq +.INDENT 0.0 +.INDENT 3.5 +privilege escalation method to use (default=sudo), use \fIansible\-doc \-t become \-l\fP to list valid choices. +.UNINDENT +.UNINDENT +.sp +\fB\-\-become\-password\-file\fP \(aqBECOME_PASSWORD_FILE\(aq, \fB\-\-become\-pass\-file\fP \(aqBECOME_PASSWORD_FILE\(aq +.INDENT 0.0 +.INDENT 3.5 +Become password file +.UNINDENT +.UNINDENT +.sp +\fB\-\-become\-user\fP \(aqBECOME_USER\(aq +.INDENT 0.0 +.INDENT 3.5 +run operations as this user (default=root) +.UNINDENT +.UNINDENT +.sp +\fB\-\-connection\-password\-file\fP \(aqCONNECTION_PASSWORD_FILE\(aq, \fB\-\-conn\-pass\-file\fP \(aqCONNECTION_PASSWORD_FILE\(aq +.INDENT 0.0 +.INDENT 3.5 +Connection password file +.UNINDENT +.UNINDENT +.sp +\fB\-\-list\-hosts\fP +.INDENT 0.0 +.INDENT 3.5 +outputs a list of matching hosts; does not execute anything else +.UNINDENT +.UNINDENT +.sp +\fB\-\-playbook\-dir\fP \(aqBASEDIR\(aq +.INDENT 0.0 +.INDENT 3.5 +Since this tool does not use playbooks, use this as a substitute playbook directory. This sets the relative path for many features including roles/ group_vars/ etc. +.UNINDENT +.UNINDENT +.sp +\fB\-\-private\-key\fP \(aqPRIVATE_KEY_FILE\(aq, \fB\-\-key\-file\fP \(aqPRIVATE_KEY_FILE\(aq +.INDENT 0.0 +.INDENT 3.5 +use this file to authenticate the connection +.UNINDENT +.UNINDENT +.sp +\fB\-\-scp\-extra\-args\fP \(aqSCP_EXTRA_ARGS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify extra arguments to pass to scp only (e.g. \-l) +.UNINDENT +.UNINDENT +.sp +\fB\-\-sftp\-extra\-args\fP \(aqSFTP_EXTRA_ARGS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify extra arguments to pass to sftp only (e.g. \-f, \-l) +.UNINDENT +.UNINDENT +.sp +\fB\-\-ssh\-common\-args\fP \(aqSSH_COMMON_ARGS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand) +.UNINDENT +.UNINDENT +.sp +\fB\-\-ssh\-extra\-args\fP \(aqSSH_EXTRA_ARGS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify extra arguments to pass to ssh only (e.g. \-R) +.UNINDENT +.UNINDENT +.sp +\fB\-\-step\fP +.INDENT 0.0 +.INDENT 3.5 +one\-step\-at\-a\-time: confirm each task before running +.UNINDENT +.UNINDENT +.sp +\fB\-\-syntax\-check\fP +.INDENT 0.0 +.INDENT 3.5 +perform a syntax check on the playbook, but do not execute it +.UNINDENT +.UNINDENT +.sp +\fB\-\-task\-timeout\fP \(aqTASK_TIMEOUT\(aq +.INDENT 0.0 +.INDENT 3.5 +set task timeout limit in seconds, must be positive integer. +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-id\fP +.INDENT 0.0 +.INDENT 3.5 +the vault identity to use +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-password\-file\fP, \fB\-\-vault\-pass\-file\fP +.INDENT 0.0 +.INDENT 3.5 +vault password file +.UNINDENT +.UNINDENT +.sp +\fB\-\-version\fP +.INDENT 0.0 +.INDENT 3.5 +show program\(aqs version number, config file location, configured module search path, module location, executable location and exit +.UNINDENT +.UNINDENT +.sp +\fB\-C\fP, \fB\-\-check\fP +.INDENT 0.0 +.INDENT 3.5 +don\(aqt make any changes; instead, try to predict some of the changes that may occur +.UNINDENT +.UNINDENT +.sp +\fB\-D\fP, \fB\-\-diff\fP +.INDENT 0.0 +.INDENT 3.5 +when changing (small) files and templates, show the differences in those files; works great with \-\-check +.UNINDENT +.UNINDENT +.sp +\fB\-K\fP, \fB\-\-ask\-become\-pass\fP +.INDENT 0.0 +.INDENT 3.5 +ask for privilege escalation password +.UNINDENT +.UNINDENT +.sp +\fB\-M\fP, \fB\-\-module\-path\fP +.INDENT 0.0 +.INDENT 3.5 +prepend colon\-separated path(s) to module library (default={{ ANSIBLE_HOME ~ \(dq/plugins/modules:/usr/share/ansible/plugins/modules\(dq }}) +.UNINDENT +.UNINDENT +.sp +\fB\-T\fP \(aqTIMEOUT\(aq, \fB\-\-timeout\fP \(aqTIMEOUT\(aq +.INDENT 0.0 +.INDENT 3.5 +override the connection timeout in seconds (default=10) +.UNINDENT +.UNINDENT +.sp +\fB\-b\fP, \fB\-\-become\fP +.INDENT 0.0 +.INDENT 3.5 +run operations with become (does not imply password prompting) +.UNINDENT +.UNINDENT +.sp +\fB\-c\fP \(aqCONNECTION\(aq, \fB\-\-connection\fP \(aqCONNECTION\(aq +.INDENT 0.0 +.INDENT 3.5 +connection type to use (default=smart) +.UNINDENT +.UNINDENT +.sp +\fB\-e\fP, \fB\-\-extra\-vars\fP +.INDENT 0.0 +.INDENT 3.5 +set additional variables as key=value or YAML/JSON, if filename prepend with @ +.UNINDENT +.UNINDENT +.sp +\fB\-f\fP \(aqFORKS\(aq, \fB\-\-forks\fP \(aqFORKS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify number of parallel processes to use (default=5) +.UNINDENT +.UNINDENT +.sp +\fB\-h\fP, \fB\-\-help\fP +.INDENT 0.0 +.INDENT 3.5 +show this help message and exit +.UNINDENT +.UNINDENT +.sp +\fB\-i\fP, \fB\-\-inventory\fP, \fB\-\-inventory\-file\fP +.INDENT 0.0 +.INDENT 3.5 +specify inventory host path or comma separated host list. \-\-inventory\-file is deprecated +.UNINDENT +.UNINDENT +.sp +\fB\-k\fP, \fB\-\-ask\-pass\fP +.INDENT 0.0 +.INDENT 3.5 +ask for connection password +.UNINDENT +.UNINDENT +.sp +\fB\-l\fP \(aqSUBSET\(aq, \fB\-\-limit\fP \(aqSUBSET\(aq +.INDENT 0.0 +.INDENT 3.5 +further limit selected hosts to an additional pattern +.UNINDENT +.UNINDENT +.sp +\fB\-u\fP \(aqREMOTE_USER\(aq, \fB\-\-user\fP \(aqREMOTE_USER\(aq +.INDENT 0.0 +.INDENT 3.5 +connect as this user (default=None) +.UNINDENT +.UNINDENT +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.INDENT 0.0 +.INDENT 3.5 +Causes Ansible to print more debug messages. Adding multiple \-v will increase the verbosity, the builtin plugins currently evaluate up to \-vvvvvv. A reasonable level to start is \-vvv, connection debugging might require \-vvvv. +.UNINDENT +.UNINDENT +.SH ENVIRONMENT +.sp +The following environment variables may be specified. +.sp +ANSIBLE_CONFIG \-\- Specify override location for the ansible config file +.sp +Many more are available for most options in ansible.cfg +.sp +For a full list check \fI\%https://docs.ansible.com/\fP\&. or use the \fIansible\-config\fP command. +.SH FILES +.sp +/etc/ansible/ansible.cfg \-\- Config file, used if present +.sp +~/.ansible.cfg \-\- User config file, overrides the default config if present +.sp +\&./ansible.cfg \-\- Local config file (in current working directory) assumed to be \(aqproject specific\(aq and overrides the rest if present. +.sp +As mentioned above, the ANSIBLE_CONFIG environment variable will override all others. +.SH AUTHOR +.sp +Ansible was originally written by Michael DeHaan. +.SH COPYRIGHT +.sp +Copyright © 2018 Red Hat, Inc | Ansible. +Ansible is released under the terms of the GPLv3 license. +.SH SEE ALSO +.sp +\fBansible\fP (1), \fBansible\-config\fP (1), \fBansible\-doc\fP (1), \fBansible\-galaxy\fP (1), \fBansible\-inventory\fP (1), \fBansible\-playbook\fP (1), \fBansible\-pull\fP (1), \fBansible\-vault\fP (1) +.sp +Extensive documentation is available in the documentation site: +<\fI\%https://docs.ansible.com\fP>. +IRC and mailing list info can be found in file CONTRIBUTING.md, +available in: <\fI\%https://github.com/ansible/ansible\fP> +.\" Generated by docutils manpage writer. +. diff --git a/docs/man/man1/ansible-doc.1 b/docs/man/man1/ansible-doc.1 new file mode 100644 index 0000000..434e92c --- /dev/null +++ b/docs/man/man1/ansible-doc.1 @@ -0,0 +1,188 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "ANSIBLE-DOC" 1 "" "Ansible 2.14.3" "System administration commands" +.SH NAME +ansible-doc \- plugin documentation tool +.SH SYNOPSIS +.INDENT 0.0 +.TP +.B usage: ansible\-doc [\-h] [\-\-version] [\-v] [\-M MODULE_PATH] +[\-\-playbook\-dir BASEDIR] +[\-t {become,cache,callback,cliconf,connection,httpapi,inventory,lookup,netconf,shell,vars,module,strategy,test,filter,role,keyword}] +[\-j] [\-r ROLES_PATH] +[\-e ENTRY_POINT | \-s | \-F | \-l | \-\-metadata\-dump] +[\-\-no\-fail\-on\-errors] +[plugin ...] +.UNINDENT +.SH DESCRIPTION +.sp +displays information on modules installed in Ansible libraries. +It displays a terse listing of plugins and their short descriptions, +provides a printout of their DOCUMENTATION strings, +and it can create a short \(dqsnippet\(dq which can be pasted into a playbook. +.SH COMMON OPTIONS +.INDENT 0.0 +.INDENT 3.5 +Plugin +.UNINDENT +.UNINDENT +.sp +\fB\-\-metadata\-dump\fP +.INDENT 0.0 +.INDENT 3.5 +\fBFor internal use only\fP Dump json metadata for all entries, ignores other options. +.UNINDENT +.UNINDENT +.sp +\fB\-\-no\-fail\-on\-errors\fP +.INDENT 0.0 +.INDENT 3.5 +\fBFor internal use only\fP Only used for \-\-metadata\-dump. Do not fail on errors. Report the error message in the JSON instead. +.UNINDENT +.UNINDENT +.sp +\fB\-\-playbook\-dir\fP \(aqBASEDIR\(aq +.INDENT 0.0 +.INDENT 3.5 +Since this tool does not use playbooks, use this as a substitute playbook directory. This sets the relative path for many features including roles/ group_vars/ etc. +.UNINDENT +.UNINDENT +.sp +\fB\-\-version\fP +.INDENT 0.0 +.INDENT 3.5 +show program\(aqs version number, config file location, configured module search path, module location, executable location and exit +.UNINDENT +.UNINDENT +.sp +\fB\-F\fP, \fB\-\-list_files\fP +.INDENT 0.0 +.INDENT 3.5 +Show plugin names and their source files without summaries (implies \-\-list). A supplied argument will be used for filtering, can be a namespace or full collection name. +.UNINDENT +.UNINDENT +.sp +\fB\-M\fP, \fB\-\-module\-path\fP +.INDENT 0.0 +.INDENT 3.5 +prepend colon\-separated path(s) to module library (default={{ ANSIBLE_HOME ~ \(dq/plugins/modules:/usr/share/ansible/plugins/modules\(dq }}) +.UNINDENT +.UNINDENT +.sp +\fB\-e\fP \(aqENTRY_POINT\(aq, \fB\-\-entry\-point\fP \(aqENTRY_POINT\(aq +.INDENT 0.0 +.INDENT 3.5 +Select the entry point for role(s). +.UNINDENT +.UNINDENT +.sp +\fB\-h\fP, \fB\-\-help\fP +.INDENT 0.0 +.INDENT 3.5 +show this help message and exit +.UNINDENT +.UNINDENT +.sp +\fB\-j\fP, \fB\-\-json\fP +.INDENT 0.0 +.INDENT 3.5 +Change output into json format. +.UNINDENT +.UNINDENT +.sp +\fB\-l\fP, \fB\-\-list\fP +.INDENT 0.0 +.INDENT 3.5 +List available plugins. A supplied argument will be used for filtering, can be a namespace or full collection name. +.UNINDENT +.UNINDENT +.sp +\fB\-r\fP, \fB\-\-roles\-path\fP +.INDENT 0.0 +.INDENT 3.5 +The path to the directory containing your roles. +.UNINDENT +.UNINDENT +.sp +\fB\-s\fP, \fB\-\-snippet\fP +.INDENT 0.0 +.INDENT 3.5 +Show playbook snippet for these plugin types: inventory, lookup, module +.UNINDENT +.UNINDENT +.sp +\fB\-t\fP \(aqTYPE\(aq, \fB\-\-type\fP \(aqTYPE\(aq +.INDENT 0.0 +.INDENT 3.5 +Choose which plugin type (defaults to \(dqmodule\(dq). Available plugin types are : (\(aqbecome\(aq, \(aqcache\(aq, \(aqcallback\(aq, \(aqcliconf\(aq, \(aqconnection\(aq, \(aqhttpapi\(aq, \(aqinventory\(aq, \(aqlookup\(aq, \(aqnetconf\(aq, \(aqshell\(aq, \(aqvars\(aq, \(aqmodule\(aq, \(aqstrategy\(aq, \(aqtest\(aq, \(aqfilter\(aq, \(aqrole\(aq, \(aqkeyword\(aq) +.UNINDENT +.UNINDENT +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.INDENT 0.0 +.INDENT 3.5 +Causes Ansible to print more debug messages. Adding multiple \-v will increase the verbosity, the builtin plugins currently evaluate up to \-vvvvvv. A reasonable level to start is \-vvv, connection debugging might require \-vvvv. +.UNINDENT +.UNINDENT +.SH ENVIRONMENT +.sp +The following environment variables may be specified. +.sp +ANSIBLE_CONFIG \-\- Specify override location for the ansible config file +.sp +Many more are available for most options in ansible.cfg +.sp +For a full list check \fI\%https://docs.ansible.com/\fP\&. or use the \fIansible\-config\fP command. +.SH FILES +.sp +/etc/ansible/ansible.cfg \-\- Config file, used if present +.sp +~/.ansible.cfg \-\- User config file, overrides the default config if present +.sp +\&./ansible.cfg \-\- Local config file (in current working directory) assumed to be \(aqproject specific\(aq and overrides the rest if present. +.sp +As mentioned above, the ANSIBLE_CONFIG environment variable will override all others. +.SH AUTHOR +.sp +Ansible was originally written by Michael DeHaan. +.SH COPYRIGHT +.sp +Copyright © 2018 Red Hat, Inc | Ansible. +Ansible is released under the terms of the GPLv3 license. +.SH SEE ALSO +.sp +\fBansible\fP (1), \fBansible\-config\fP (1), \fBansible\-console\fP (1), \fBansible\-galaxy\fP (1), \fBansible\-inventory\fP (1), \fBansible\-playbook\fP (1), \fBansible\-pull\fP (1), \fBansible\-vault\fP (1) +.sp +Extensive documentation is available in the documentation site: +<\fI\%https://docs.ansible.com\fP>. +IRC and mailing list info can be found in file CONTRIBUTING.md, +available in: <\fI\%https://github.com/ansible/ansible\fP> +.\" Generated by docutils manpage writer. +. diff --git a/docs/man/man1/ansible-galaxy.1 b/docs/man/man1/ansible-galaxy.1 new file mode 100644 index 0000000..646e1b9 --- /dev/null +++ b/docs/man/man1/ansible-galaxy.1 @@ -0,0 +1,108 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "ANSIBLE-GALAXY" 1 "" "Ansible 2.14.3" "System administration commands" +.SH NAME +ansible-galaxy \- Perform various Role and Collection related operations. +.SH SYNOPSIS +.sp +usage: ansible\-galaxy [\-h] [\-\-version] [\-v] TYPE ... +.SH DESCRIPTION +.sp +Command to manage Ansible roles and collections. +.sp +None of the CLI tools are designed to run concurrently with themselves. +Use an external scheduler and/or locking to ensure there are no clashing +operations. +.SH COMMON OPTIONS +.sp +\fB\-\-version\fP +.INDENT 0.0 +.INDENT 3.5 +show program\(aqs version number, config file location, configured module search path, module location, executable location and exit +.UNINDENT +.UNINDENT +.sp +\fB\-h\fP, \fB\-\-help\fP +.INDENT 0.0 +.INDENT 3.5 +show this help message and exit +.UNINDENT +.UNINDENT +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.INDENT 0.0 +.INDENT 3.5 +Causes Ansible to print more debug messages. Adding multiple \-v will increase the verbosity, the builtin plugins currently evaluate up to \-vvvvvv. A reasonable level to start is \-vvv, connection debugging might require \-vvvv. +.UNINDENT +.UNINDENT +.SH ACTIONS +.INDENT 0.0 +.TP +.B \fBcollection\fP +Perform the action on an Ansible Galaxy collection. Must be combined with a further action like init/install as listed below. +.TP +.B \fBrole\fP +Perform the action on an Ansible Galaxy role. Must be combined with a further action like delete/install/init as listed below. +.UNINDENT +.SH ENVIRONMENT +.sp +The following environment variables may be specified. +.sp +ANSIBLE_CONFIG \-\- Specify override location for the ansible config file +.sp +Many more are available for most options in ansible.cfg +.sp +For a full list check \fI\%https://docs.ansible.com/\fP\&. or use the \fIansible\-config\fP command. +.SH FILES +.sp +/etc/ansible/ansible.cfg \-\- Config file, used if present +.sp +~/.ansible.cfg \-\- User config file, overrides the default config if present +.sp +\&./ansible.cfg \-\- Local config file (in current working directory) assumed to be \(aqproject specific\(aq and overrides the rest if present. +.sp +As mentioned above, the ANSIBLE_CONFIG environment variable will override all others. +.SH AUTHOR +.sp +Ansible was originally written by Michael DeHaan. +.SH COPYRIGHT +.sp +Copyright © 2018 Red Hat, Inc | Ansible. +Ansible is released under the terms of the GPLv3 license. +.SH SEE ALSO +.sp +\fBansible\fP (1), \fBansible\-config\fP (1), \fBansible\-console\fP (1), \fBansible\-doc\fP (1), \fBansible\-inventory\fP (1), \fBansible\-playbook\fP (1), \fBansible\-pull\fP (1), \fBansible\-vault\fP (1) +.sp +Extensive documentation is available in the documentation site: +<\fI\%https://docs.ansible.com\fP>. +IRC and mailing list info can be found in file CONTRIBUTING.md, +available in: <\fI\%https://github.com/ansible/ansible\fP> +.\" Generated by docutils manpage writer. +. diff --git a/docs/man/man1/ansible-inventory.1 b/docs/man/man1/ansible-inventory.1 new file mode 100644 index 0000000..dcf9152 --- /dev/null +++ b/docs/man/man1/ansible-inventory.1 @@ -0,0 +1,220 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "ANSIBLE-INVENTORY" 1 "" "Ansible 2.14.3" "System administration commands" +.SH NAME +ansible-inventory \- None +.SH SYNOPSIS +.INDENT 0.0 +.TP +.B usage: ansible\-inventory [\-h] [\-\-version] [\-v] [\-i INVENTORY] +[\-\-vault\-id VAULT_IDS] +[\-\-ask\-vault\-password | \-\-vault\-password\-file VAULT_PASSWORD_FILES] +[\-\-playbook\-dir BASEDIR] [\-e EXTRA_VARS] [\-\-list] +[\-\-host HOST] [\-\-graph] [\-y] [\-\-toml] [\-\-vars] +[\-\-export] [\-\-output OUTPUT_FILE] +[host|group] +.UNINDENT +.SH DESCRIPTION +.sp +used to display or dump the configured inventory as Ansible sees it +.SH COMMON OPTIONS +.INDENT 0.0 +.INDENT 3.5 +None +.UNINDENT +.UNINDENT +.sp +\fB\-\-ask\-vault\-password\fP, \fB\-\-ask\-vault\-pass\fP +.INDENT 0.0 +.INDENT 3.5 +ask for vault password +.UNINDENT +.UNINDENT +.sp +\fB\-\-export\fP +.INDENT 0.0 +.INDENT 3.5 +When doing an \-\-list, represent in a way that is optimized for export,not as an accurate representation of how Ansible has processed it +.UNINDENT +.UNINDENT +.sp +\fB\-\-graph\fP +.INDENT 0.0 +.INDENT 3.5 +create inventory graph, if supplying pattern it must be a valid group name +.UNINDENT +.UNINDENT +.sp +\fB\-\-host\fP \(aqHOST\(aq +.INDENT 0.0 +.INDENT 3.5 +Output specific host info, works as inventory script +.UNINDENT +.UNINDENT +.sp +\fB\-\-list\fP +.INDENT 0.0 +.INDENT 3.5 +Output all hosts info, works as inventory script +.UNINDENT +.UNINDENT +.sp +\fB\-\-list\-hosts\fP +.INDENT 0.0 +.INDENT 3.5 +==SUPPRESS== +.UNINDENT +.UNINDENT +.sp +\fB\-\-output\fP \(aqOUTPUT_FILE\(aq +.INDENT 0.0 +.INDENT 3.5 +When doing \-\-list, send the inventory to a file instead of to the screen +.UNINDENT +.UNINDENT +.sp +\fB\-\-playbook\-dir\fP \(aqBASEDIR\(aq +.INDENT 0.0 +.INDENT 3.5 +Since this tool does not use playbooks, use this as a substitute playbook directory. This sets the relative path for many features including roles/ group_vars/ etc. +.UNINDENT +.UNINDENT +.sp +\fB\-\-toml\fP +.INDENT 0.0 +.INDENT 3.5 +Use TOML format instead of default JSON, ignored for \-\-graph +.UNINDENT +.UNINDENT +.sp +\fB\-\-vars\fP +.INDENT 0.0 +.INDENT 3.5 +Add vars to graph display, ignored unless used with \-\-graph +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-id\fP +.INDENT 0.0 +.INDENT 3.5 +the vault identity to use +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-password\-file\fP, \fB\-\-vault\-pass\-file\fP +.INDENT 0.0 +.INDENT 3.5 +vault password file +.UNINDENT +.UNINDENT +.sp +\fB\-\-version\fP +.INDENT 0.0 +.INDENT 3.5 +show program\(aqs version number, config file location, configured module search path, module location, executable location and exit +.UNINDENT +.UNINDENT +.sp +\fB\-e\fP, \fB\-\-extra\-vars\fP +.INDENT 0.0 +.INDENT 3.5 +set additional variables as key=value or YAML/JSON, if filename prepend with @ +.UNINDENT +.UNINDENT +.sp +\fB\-h\fP, \fB\-\-help\fP +.INDENT 0.0 +.INDENT 3.5 +show this help message and exit +.UNINDENT +.UNINDENT +.sp +\fB\-i\fP, \fB\-\-inventory\fP, \fB\-\-inventory\-file\fP +.INDENT 0.0 +.INDENT 3.5 +specify inventory host path or comma separated host list. \-\-inventory\-file is deprecated +.UNINDENT +.UNINDENT +.sp +\fB\-l\fP, \fB\-\-limit\fP +.INDENT 0.0 +.INDENT 3.5 +==SUPPRESS== +.UNINDENT +.UNINDENT +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.INDENT 0.0 +.INDENT 3.5 +Causes Ansible to print more debug messages. Adding multiple \-v will increase the verbosity, the builtin plugins currently evaluate up to \-vvvvvv. A reasonable level to start is \-vvv, connection debugging might require \-vvvv. +.UNINDENT +.UNINDENT +.sp +\fB\-y\fP, \fB\-\-yaml\fP +.INDENT 0.0 +.INDENT 3.5 +Use YAML format instead of default JSON, ignored for \-\-graph +.UNINDENT +.UNINDENT +.SH ENVIRONMENT +.sp +The following environment variables may be specified. +.sp +ANSIBLE_CONFIG \-\- Specify override location for the ansible config file +.sp +Many more are available for most options in ansible.cfg +.sp +For a full list check \fI\%https://docs.ansible.com/\fP\&. or use the \fIansible\-config\fP command. +.SH FILES +.sp +/etc/ansible/ansible.cfg \-\- Config file, used if present +.sp +~/.ansible.cfg \-\- User config file, overrides the default config if present +.sp +\&./ansible.cfg \-\- Local config file (in current working directory) assumed to be \(aqproject specific\(aq and overrides the rest if present. +.sp +As mentioned above, the ANSIBLE_CONFIG environment variable will override all others. +.SH AUTHOR +.sp +Ansible was originally written by Michael DeHaan. +.SH COPYRIGHT +.sp +Copyright © 2018 Red Hat, Inc | Ansible. +Ansible is released under the terms of the GPLv3 license. +.SH SEE ALSO +.sp +\fBansible\fP (1), \fBansible\-config\fP (1), \fBansible\-console\fP (1), \fBansible\-doc\fP (1), \fBansible\-galaxy\fP (1), \fBansible\-playbook\fP (1), \fBansible\-pull\fP (1), \fBansible\-vault\fP (1) +.sp +Extensive documentation is available in the documentation site: +<\fI\%https://docs.ansible.com\fP>. +IRC and mailing list info can be found in file CONTRIBUTING.md, +available in: <\fI\%https://github.com/ansible/ansible\fP> +.\" Generated by docutils manpage writer. +. diff --git a/docs/man/man1/ansible-playbook.1 b/docs/man/man1/ansible-playbook.1 new file mode 100644 index 0000000..42b123f --- /dev/null +++ b/docs/man/man1/ansible-playbook.1 @@ -0,0 +1,366 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "ANSIBLE-PLAYBOOK" 1 "" "Ansible 2.14.3" "System administration commands" +.SH NAME +ansible-playbook \- Runs Ansible playbooks, executing the defined tasks on the targeted hosts. +.SH SYNOPSIS +.INDENT 0.0 +.TP +.B usage: ansible\-playbook [\-h] [\-\-version] [\-v] [\-\-private\-key PRIVATE_KEY_FILE] +[\-u REMOTE_USER] [\-c CONNECTION] [\-T TIMEOUT] +[\-\-ssh\-common\-args SSH_COMMON_ARGS] +[\-\-sftp\-extra\-args SFTP_EXTRA_ARGS] +[\-\-scp\-extra\-args SCP_EXTRA_ARGS] +[\-\-ssh\-extra\-args SSH_EXTRA_ARGS] +[\-k | \-\-connection\-password\-file CONNECTION_PASSWORD_FILE] +[\-\-force\-handlers] [\-\-flush\-cache] [\-b] +[\-\-become\-method BECOME_METHOD] +[\-\-become\-user BECOME_USER] +[\-K | \-\-become\-password\-file BECOME_PASSWORD_FILE] +[\-t TAGS] [\-\-skip\-tags SKIP_TAGS] [\-C] +[\-\-syntax\-check] [\-D] [\-i INVENTORY] [\-\-list\-hosts] +[\-l SUBSET] [\-e EXTRA_VARS] [\-\-vault\-id VAULT_IDS] +[\-\-ask\-vault\-password | \-\-vault\-password\-file VAULT_PASSWORD_FILES] +[\-f FORKS] [\-M MODULE_PATH] [\-\-list\-tasks] +[\-\-list\-tags] [\-\-step] [\-\-start\-at\-task START_AT_TASK] +playbook [playbook ...] +.UNINDENT +.SH DESCRIPTION +.sp +the tool to run \fIAnsible playbooks\fP, which are a configuration and multinode +deployment system. +See the project home page (\fI\%https://docs.ansible.com\fP) for more information. +.SH COMMON OPTIONS +.INDENT 0.0 +.INDENT 3.5 +Playbook(s) +.UNINDENT +.UNINDENT +.sp +\fB\-\-ask\-vault\-password\fP, \fB\-\-ask\-vault\-pass\fP +.INDENT 0.0 +.INDENT 3.5 +ask for vault password +.UNINDENT +.UNINDENT +.sp +\fB\-\-become\-method\fP \(aqBECOME_METHOD\(aq +.INDENT 0.0 +.INDENT 3.5 +privilege escalation method to use (default=sudo), use \fIansible\-doc \-t become \-l\fP to list valid choices. +.UNINDENT +.UNINDENT +.sp +\fB\-\-become\-password\-file\fP \(aqBECOME_PASSWORD_FILE\(aq, \fB\-\-become\-pass\-file\fP \(aqBECOME_PASSWORD_FILE\(aq +.INDENT 0.0 +.INDENT 3.5 +Become password file +.UNINDENT +.UNINDENT +.sp +\fB\-\-become\-user\fP \(aqBECOME_USER\(aq +.INDENT 0.0 +.INDENT 3.5 +run operations as this user (default=root) +.UNINDENT +.UNINDENT +.sp +\fB\-\-connection\-password\-file\fP \(aqCONNECTION_PASSWORD_FILE\(aq, \fB\-\-conn\-pass\-file\fP \(aqCONNECTION_PASSWORD_FILE\(aq +.INDENT 0.0 +.INDENT 3.5 +Connection password file +.UNINDENT +.UNINDENT +.sp +\fB\-\-flush\-cache\fP +.INDENT 0.0 +.INDENT 3.5 +clear the fact cache for every host in inventory +.UNINDENT +.UNINDENT +.sp +\fB\-\-force\-handlers\fP +.INDENT 0.0 +.INDENT 3.5 +run handlers even if a task fails +.UNINDENT +.UNINDENT +.sp +\fB\-\-list\-hosts\fP +.INDENT 0.0 +.INDENT 3.5 +outputs a list of matching hosts; does not execute anything else +.UNINDENT +.UNINDENT +.sp +\fB\-\-list\-tags\fP +.INDENT 0.0 +.INDENT 3.5 +list all available tags +.UNINDENT +.UNINDENT +.sp +\fB\-\-list\-tasks\fP +.INDENT 0.0 +.INDENT 3.5 +list all tasks that would be executed +.UNINDENT +.UNINDENT +.sp +\fB\-\-private\-key\fP \(aqPRIVATE_KEY_FILE\(aq, \fB\-\-key\-file\fP \(aqPRIVATE_KEY_FILE\(aq +.INDENT 0.0 +.INDENT 3.5 +use this file to authenticate the connection +.UNINDENT +.UNINDENT +.sp +\fB\-\-scp\-extra\-args\fP \(aqSCP_EXTRA_ARGS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify extra arguments to pass to scp only (e.g. \-l) +.UNINDENT +.UNINDENT +.sp +\fB\-\-sftp\-extra\-args\fP \(aqSFTP_EXTRA_ARGS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify extra arguments to pass to sftp only (e.g. \-f, \-l) +.UNINDENT +.UNINDENT +.sp +\fB\-\-skip\-tags\fP +.INDENT 0.0 +.INDENT 3.5 +only run plays and tasks whose tags do not match these values +.UNINDENT +.UNINDENT +.sp +\fB\-\-ssh\-common\-args\fP \(aqSSH_COMMON_ARGS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand) +.UNINDENT +.UNINDENT +.sp +\fB\-\-ssh\-extra\-args\fP \(aqSSH_EXTRA_ARGS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify extra arguments to pass to ssh only (e.g. \-R) +.UNINDENT +.UNINDENT +.sp +\fB\-\-start\-at\-task\fP \(aqSTART_AT_TASK\(aq +.INDENT 0.0 +.INDENT 3.5 +start the playbook at the task matching this name +.UNINDENT +.UNINDENT +.sp +\fB\-\-step\fP +.INDENT 0.0 +.INDENT 3.5 +one\-step\-at\-a\-time: confirm each task before running +.UNINDENT +.UNINDENT +.sp +\fB\-\-syntax\-check\fP +.INDENT 0.0 +.INDENT 3.5 +perform a syntax check on the playbook, but do not execute it +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-id\fP +.INDENT 0.0 +.INDENT 3.5 +the vault identity to use +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-password\-file\fP, \fB\-\-vault\-pass\-file\fP +.INDENT 0.0 +.INDENT 3.5 +vault password file +.UNINDENT +.UNINDENT +.sp +\fB\-\-version\fP +.INDENT 0.0 +.INDENT 3.5 +show program\(aqs version number, config file location, configured module search path, module location, executable location and exit +.UNINDENT +.UNINDENT +.sp +\fB\-C\fP, \fB\-\-check\fP +.INDENT 0.0 +.INDENT 3.5 +don\(aqt make any changes; instead, try to predict some of the changes that may occur +.UNINDENT +.UNINDENT +.sp +\fB\-D\fP, \fB\-\-diff\fP +.INDENT 0.0 +.INDENT 3.5 +when changing (small) files and templates, show the differences in those files; works great with \-\-check +.UNINDENT +.UNINDENT +.sp +\fB\-K\fP, \fB\-\-ask\-become\-pass\fP +.INDENT 0.0 +.INDENT 3.5 +ask for privilege escalation password +.UNINDENT +.UNINDENT +.sp +\fB\-M\fP, \fB\-\-module\-path\fP +.INDENT 0.0 +.INDENT 3.5 +prepend colon\-separated path(s) to module library (default={{ ANSIBLE_HOME ~ \(dq/plugins/modules:/usr/share/ansible/plugins/modules\(dq }}) +.UNINDENT +.UNINDENT +.sp +\fB\-T\fP \(aqTIMEOUT\(aq, \fB\-\-timeout\fP \(aqTIMEOUT\(aq +.INDENT 0.0 +.INDENT 3.5 +override the connection timeout in seconds (default=10) +.UNINDENT +.UNINDENT +.sp +\fB\-b\fP, \fB\-\-become\fP +.INDENT 0.0 +.INDENT 3.5 +run operations with become (does not imply password prompting) +.UNINDENT +.UNINDENT +.sp +\fB\-c\fP \(aqCONNECTION\(aq, \fB\-\-connection\fP \(aqCONNECTION\(aq +.INDENT 0.0 +.INDENT 3.5 +connection type to use (default=smart) +.UNINDENT +.UNINDENT +.sp +\fB\-e\fP, \fB\-\-extra\-vars\fP +.INDENT 0.0 +.INDENT 3.5 +set additional variables as key=value or YAML/JSON, if filename prepend with @ +.UNINDENT +.UNINDENT +.sp +\fB\-f\fP \(aqFORKS\(aq, \fB\-\-forks\fP \(aqFORKS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify number of parallel processes to use (default=5) +.UNINDENT +.UNINDENT +.sp +\fB\-h\fP, \fB\-\-help\fP +.INDENT 0.0 +.INDENT 3.5 +show this help message and exit +.UNINDENT +.UNINDENT +.sp +\fB\-i\fP, \fB\-\-inventory\fP, \fB\-\-inventory\-file\fP +.INDENT 0.0 +.INDENT 3.5 +specify inventory host path or comma separated host list. \-\-inventory\-file is deprecated +.UNINDENT +.UNINDENT +.sp +\fB\-k\fP, \fB\-\-ask\-pass\fP +.INDENT 0.0 +.INDENT 3.5 +ask for connection password +.UNINDENT +.UNINDENT +.sp +\fB\-l\fP \(aqSUBSET\(aq, \fB\-\-limit\fP \(aqSUBSET\(aq +.INDENT 0.0 +.INDENT 3.5 +further limit selected hosts to an additional pattern +.UNINDENT +.UNINDENT +.sp +\fB\-t\fP, \fB\-\-tags\fP +.INDENT 0.0 +.INDENT 3.5 +only run plays and tasks tagged with these values +.UNINDENT +.UNINDENT +.sp +\fB\-u\fP \(aqREMOTE_USER\(aq, \fB\-\-user\fP \(aqREMOTE_USER\(aq +.INDENT 0.0 +.INDENT 3.5 +connect as this user (default=None) +.UNINDENT +.UNINDENT +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.INDENT 0.0 +.INDENT 3.5 +Causes Ansible to print more debug messages. Adding multiple \-v will increase the verbosity, the builtin plugins currently evaluate up to \-vvvvvv. A reasonable level to start is \-vvv, connection debugging might require \-vvvv. +.UNINDENT +.UNINDENT +.SH ENVIRONMENT +.sp +The following environment variables may be specified. +.sp +ANSIBLE_CONFIG \-\- Specify override location for the ansible config file +.sp +Many more are available for most options in ansible.cfg +.sp +For a full list check \fI\%https://docs.ansible.com/\fP\&. or use the \fIansible\-config\fP command. +.SH FILES +.sp +/etc/ansible/ansible.cfg \-\- Config file, used if present +.sp +~/.ansible.cfg \-\- User config file, overrides the default config if present +.sp +\&./ansible.cfg \-\- Local config file (in current working directory) assumed to be \(aqproject specific\(aq and overrides the rest if present. +.sp +As mentioned above, the ANSIBLE_CONFIG environment variable will override all others. +.SH AUTHOR +.sp +Ansible was originally written by Michael DeHaan. +.SH COPYRIGHT +.sp +Copyright © 2018 Red Hat, Inc | Ansible. +Ansible is released under the terms of the GPLv3 license. +.SH SEE ALSO +.sp +\fBansible\fP (1), \fBansible\-config\fP (1), \fBansible\-console\fP (1), \fBansible\-doc\fP (1), \fBansible\-galaxy\fP (1), \fBansible\-inventory\fP (1), \fBansible\-pull\fP (1), \fBansible\-vault\fP (1) +.sp +Extensive documentation is available in the documentation site: +<\fI\%https://docs.ansible.com\fP>. +IRC and mailing list info can be found in file CONTRIBUTING.md, +available in: <\fI\%https://github.com/ansible/ansible\fP> +.\" Generated by docutils manpage writer. +. diff --git a/docs/man/man1/ansible-pull.1 b/docs/man/man1/ansible-pull.1 new file mode 100644 index 0000000..2fe0c03 --- /dev/null +++ b/docs/man/man1/ansible-pull.1 @@ -0,0 +1,391 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "ANSIBLE-PULL" 1 "" "Ansible 2.14.3" "System administration commands" +.SH NAME +ansible-pull \- pulls playbooks from a VCS repo and executes them for the local host +.SH SYNOPSIS +.INDENT 0.0 +.TP +.B usage: ansible\-pull [\-h] [\-\-version] [\-v] [\-\-private\-key PRIVATE_KEY_FILE] +[\-u REMOTE_USER] [\-c CONNECTION] [\-T TIMEOUT] +[\-\-ssh\-common\-args SSH_COMMON_ARGS] +[\-\-sftp\-extra\-args SFTP_EXTRA_ARGS] +[\-\-scp\-extra\-args SCP_EXTRA_ARGS] +[\-\-ssh\-extra\-args SSH_EXTRA_ARGS] +[\-k | \-\-connection\-password\-file CONNECTION_PASSWORD_FILE] +[\-\-vault\-id VAULT_IDS] +[\-\-ask\-vault\-password | \-\-vault\-password\-file VAULT_PASSWORD_FILES] +[\-e EXTRA_VARS] [\-t TAGS] [\-\-skip\-tags SKIP_TAGS] +[\-i INVENTORY] [\-\-list\-hosts] [\-l SUBSET] [\-M MODULE_PATH] +[\-K | \-\-become\-password\-file BECOME_PASSWORD_FILE] +[\-\-purge] [\-o] [\-s SLEEP] [\-f] [\-d DEST] [\-U URL] [\-\-full] +[\-C CHECKOUT] [\-\-accept\-host\-key] [\-m MODULE_NAME] +[\-\-verify\-commit] [\-\-clean] [\-\-track\-subs] [\-\-check] +[\-\-diff] +[playbook.yml ...] +.UNINDENT +.SH DESCRIPTION +.sp +Used to pull a remote copy of ansible on each managed node, +each set to run via cron and update playbook source via a source repository. +This inverts the default \fIpush\fP architecture of ansible into a \fIpull\fP +architecture, +which has near\-limitless scaling potential. +.sp +None of the CLI tools are designed to run concurrently with themselves, +you should use an external scheduler and/or locking to ensure there are no +clashing operations. +.sp +The setup playbook can be tuned to change the cron frequency, logging +locations, and parameters to ansible\-pull. +This is useful both for extreme scale\-out as well as periodic remediation. +Usage of the \(aqfetch\(aq module to retrieve logs from ansible\-pull runs would be an +excellent way to gather and analyze remote logs from ansible\-pull. +.SH COMMON OPTIONS +.INDENT 0.0 +.INDENT 3.5 +Playbook(s) +.UNINDENT +.UNINDENT +.sp +\fB\-\-accept\-host\-key\fP +.INDENT 0.0 +.INDENT 3.5 +adds the hostkey for the repo url if not already added +.UNINDENT +.UNINDENT +.sp +\fB\-\-ask\-vault\-password\fP, \fB\-\-ask\-vault\-pass\fP +.INDENT 0.0 +.INDENT 3.5 +ask for vault password +.UNINDENT +.UNINDENT +.sp +\fB\-\-become\-password\-file\fP \(aqBECOME_PASSWORD_FILE\(aq, \fB\-\-become\-pass\-file\fP \(aqBECOME_PASSWORD_FILE\(aq +.INDENT 0.0 +.INDENT 3.5 +Become password file +.UNINDENT +.UNINDENT +.sp +\fB\-\-check\fP +.INDENT 0.0 +.INDENT 3.5 +don\(aqt make any changes; instead, try to predict some of the changes that may occur +.UNINDENT +.UNINDENT +.sp +\fB\-\-clean\fP +.INDENT 0.0 +.INDENT 3.5 +modified files in the working repository will be discarded +.UNINDENT +.UNINDENT +.sp +\fB\-\-connection\-password\-file\fP \(aqCONNECTION_PASSWORD_FILE\(aq, \fB\-\-conn\-pass\-file\fP \(aqCONNECTION_PASSWORD_FILE\(aq +.INDENT 0.0 +.INDENT 3.5 +Connection password file +.UNINDENT +.UNINDENT +.sp +\fB\-\-diff\fP +.INDENT 0.0 +.INDENT 3.5 +when changing (small) files and templates, show the differences in those files; works great with \-\-check +.UNINDENT +.UNINDENT +.sp +\fB\-\-full\fP +.INDENT 0.0 +.INDENT 3.5 +Do a full clone, instead of a shallow one. +.UNINDENT +.UNINDENT +.sp +\fB\-\-list\-hosts\fP +.INDENT 0.0 +.INDENT 3.5 +outputs a list of matching hosts; does not execute anything else +.UNINDENT +.UNINDENT +.sp +\fB\-\-private\-key\fP \(aqPRIVATE_KEY_FILE\(aq, \fB\-\-key\-file\fP \(aqPRIVATE_KEY_FILE\(aq +.INDENT 0.0 +.INDENT 3.5 +use this file to authenticate the connection +.UNINDENT +.UNINDENT +.sp +\fB\-\-purge\fP +.INDENT 0.0 +.INDENT 3.5 +purge checkout after playbook run +.UNINDENT +.UNINDENT +.sp +\fB\-\-scp\-extra\-args\fP \(aqSCP_EXTRA_ARGS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify extra arguments to pass to scp only (e.g. \-l) +.UNINDENT +.UNINDENT +.sp +\fB\-\-sftp\-extra\-args\fP \(aqSFTP_EXTRA_ARGS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify extra arguments to pass to sftp only (e.g. \-f, \-l) +.UNINDENT +.UNINDENT +.sp +\fB\-\-skip\-tags\fP +.INDENT 0.0 +.INDENT 3.5 +only run plays and tasks whose tags do not match these values +.UNINDENT +.UNINDENT +.sp +\fB\-\-ssh\-common\-args\fP \(aqSSH_COMMON_ARGS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand) +.UNINDENT +.UNINDENT +.sp +\fB\-\-ssh\-extra\-args\fP \(aqSSH_EXTRA_ARGS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify extra arguments to pass to ssh only (e.g. \-R) +.UNINDENT +.UNINDENT +.sp +\fB\-\-track\-subs\fP +.INDENT 0.0 +.INDENT 3.5 +submodules will track the latest changes. This is equivalent to specifying the \-\-remote flag to git submodule update +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-id\fP +.INDENT 0.0 +.INDENT 3.5 +the vault identity to use +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-password\-file\fP, \fB\-\-vault\-pass\-file\fP +.INDENT 0.0 +.INDENT 3.5 +vault password file +.UNINDENT +.UNINDENT +.sp +\fB\-\-verify\-commit\fP +.INDENT 0.0 +.INDENT 3.5 +verify GPG signature of checked out commit, if it fails abort running the playbook. This needs the corresponding VCS module to support such an operation +.UNINDENT +.UNINDENT +.sp +\fB\-\-version\fP +.INDENT 0.0 +.INDENT 3.5 +show program\(aqs version number, config file location, configured module search path, module location, executable location and exit +.UNINDENT +.UNINDENT +.sp +\fB\-C\fP \(aqCHECKOUT\(aq, \fB\-\-checkout\fP \(aqCHECKOUT\(aq +.INDENT 0.0 +.INDENT 3.5 +branch/tag/commit to checkout. Defaults to behavior of repository module. +.UNINDENT +.UNINDENT +.sp +\fB\-K\fP, \fB\-\-ask\-become\-pass\fP +.INDENT 0.0 +.INDENT 3.5 +ask for privilege escalation password +.UNINDENT +.UNINDENT +.sp +\fB\-M\fP, \fB\-\-module\-path\fP +.INDENT 0.0 +.INDENT 3.5 +prepend colon\-separated path(s) to module library (default={{ ANSIBLE_HOME ~ \(dq/plugins/modules:/usr/share/ansible/plugins/modules\(dq }}) +.UNINDENT +.UNINDENT +.sp +\fB\-T\fP \(aqTIMEOUT\(aq, \fB\-\-timeout\fP \(aqTIMEOUT\(aq +.INDENT 0.0 +.INDENT 3.5 +override the connection timeout in seconds (default=10) +.UNINDENT +.UNINDENT +.sp +\fB\-U\fP \(aqURL\(aq, \fB\-\-url\fP \(aqURL\(aq +.INDENT 0.0 +.INDENT 3.5 +URL of the playbook repository +.UNINDENT +.UNINDENT +.sp +\fB\-c\fP \(aqCONNECTION\(aq, \fB\-\-connection\fP \(aqCONNECTION\(aq +.INDENT 0.0 +.INDENT 3.5 +connection type to use (default=smart) +.UNINDENT +.UNINDENT +.sp +\fB\-d\fP \(aqDEST\(aq, \fB\-\-directory\fP \(aqDEST\(aq +.INDENT 0.0 +.INDENT 3.5 +absolute path of repository checkout directory (relative paths are not supported) +.UNINDENT +.UNINDENT +.sp +\fB\-e\fP, \fB\-\-extra\-vars\fP +.INDENT 0.0 +.INDENT 3.5 +set additional variables as key=value or YAML/JSON, if filename prepend with @ +.UNINDENT +.UNINDENT +.sp +\fB\-f\fP, \fB\-\-force\fP +.INDENT 0.0 +.INDENT 3.5 +run the playbook even if the repository could not be updated +.UNINDENT +.UNINDENT +.sp +\fB\-h\fP, \fB\-\-help\fP +.INDENT 0.0 +.INDENT 3.5 +show this help message and exit +.UNINDENT +.UNINDENT +.sp +\fB\-i\fP, \fB\-\-inventory\fP, \fB\-\-inventory\-file\fP +.INDENT 0.0 +.INDENT 3.5 +specify inventory host path or comma separated host list. \-\-inventory\-file is deprecated +.UNINDENT +.UNINDENT +.sp +\fB\-k\fP, \fB\-\-ask\-pass\fP +.INDENT 0.0 +.INDENT 3.5 +ask for connection password +.UNINDENT +.UNINDENT +.sp +\fB\-l\fP \(aqSUBSET\(aq, \fB\-\-limit\fP \(aqSUBSET\(aq +.INDENT 0.0 +.INDENT 3.5 +further limit selected hosts to an additional pattern +.UNINDENT +.UNINDENT +.sp +\fB\-m\fP \(aqMODULE_NAME\(aq, \fB\-\-module\-name\fP \(aqMODULE_NAME\(aq +.INDENT 0.0 +.INDENT 3.5 +Repository module name, which ansible will use to check out the repo. Choices are (\(aqgit\(aq, \(aqsubversion\(aq, \(aqhg\(aq, \(aqbzr\(aq). Default is git. +.UNINDENT +.UNINDENT +.sp +\fB\-o\fP, \fB\-\-only\-if\-changed\fP +.INDENT 0.0 +.INDENT 3.5 +only run the playbook if the repository has been updated +.UNINDENT +.UNINDENT +.sp +\fB\-s\fP \(aqSLEEP\(aq, \fB\-\-sleep\fP \(aqSLEEP\(aq +.INDENT 0.0 +.INDENT 3.5 +sleep for random interval (between 0 and n number of seconds) before starting. This is a useful way to disperse git requests +.UNINDENT +.UNINDENT +.sp +\fB\-t\fP, \fB\-\-tags\fP +.INDENT 0.0 +.INDENT 3.5 +only run plays and tasks tagged with these values +.UNINDENT +.UNINDENT +.sp +\fB\-u\fP \(aqREMOTE_USER\(aq, \fB\-\-user\fP \(aqREMOTE_USER\(aq +.INDENT 0.0 +.INDENT 3.5 +connect as this user (default=None) +.UNINDENT +.UNINDENT +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.INDENT 0.0 +.INDENT 3.5 +Causes Ansible to print more debug messages. Adding multiple \-v will increase the verbosity, the builtin plugins currently evaluate up to \-vvvvvv. A reasonable level to start is \-vvv, connection debugging might require \-vvvv. +.UNINDENT +.UNINDENT +.SH ENVIRONMENT +.sp +The following environment variables may be specified. +.sp +ANSIBLE_CONFIG \-\- Specify override location for the ansible config file +.sp +Many more are available for most options in ansible.cfg +.sp +For a full list check \fI\%https://docs.ansible.com/\fP\&. or use the \fIansible\-config\fP command. +.SH FILES +.sp +/etc/ansible/ansible.cfg \-\- Config file, used if present +.sp +~/.ansible.cfg \-\- User config file, overrides the default config if present +.sp +\&./ansible.cfg \-\- Local config file (in current working directory) assumed to be \(aqproject specific\(aq and overrides the rest if present. +.sp +As mentioned above, the ANSIBLE_CONFIG environment variable will override all others. +.SH AUTHOR +.sp +Ansible was originally written by Michael DeHaan. +.SH COPYRIGHT +.sp +Copyright © 2018 Red Hat, Inc | Ansible. +Ansible is released under the terms of the GPLv3 license. +.SH SEE ALSO +.sp +\fBansible\fP (1), \fBansible\-config\fP (1), \fBansible\-console\fP (1), \fBansible\-doc\fP (1), \fBansible\-galaxy\fP (1), \fBansible\-inventory\fP (1), \fBansible\-playbook\fP (1), \fBansible\-vault\fP (1) +.sp +Extensive documentation is available in the documentation site: +<\fI\%https://docs.ansible.com\fP>. +IRC and mailing list info can be found in file CONTRIBUTING.md, +available in: <\fI\%https://github.com/ansible/ansible\fP> +.\" Generated by docutils manpage writer. +. diff --git a/docs/man/man1/ansible-vault.1 b/docs/man/man1/ansible-vault.1 new file mode 100644 index 0000000..42e7d7a --- /dev/null +++ b/docs/man/man1/ansible-vault.1 @@ -0,0 +1,378 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "ANSIBLE-VAULT" 1 "" "Ansible 2.14.3" "System administration commands" +.SH NAME +ansible-vault \- encryption/decryption utility for Ansible data files +.SH SYNOPSIS +.INDENT 0.0 +.TP +.B usage: ansible\-vault [\-h] [\-\-version] [\-v] +{create,decrypt,edit,view,encrypt,encrypt_string,rekey} +\&... +.UNINDENT +.SH DESCRIPTION +.sp +can encrypt any structured data file used by Ansible. +This can include \fIgroup_vars/\fP or \fIhost_vars/\fP inventory variables, +variables loaded by \fIinclude_vars\fP or \fIvars_files\fP, or variable files +passed on the ansible\-playbook command line with \fI\-e @file.yml\fP or \fI\-e +@file.json\fP\&. +Role variables and defaults are also included! +.sp +Because Ansible tasks, handlers, and other objects are data, these can also be +encrypted with vault. +If you\(aqd like to not expose what variables you are using, you can keep an +individual task file entirely encrypted. +.SH COMMON OPTIONS +.sp +\fB\-\-version\fP +.INDENT 0.0 +.INDENT 3.5 +show program\(aqs version number, config file location, configured module search path, module location, executable location and exit +.UNINDENT +.UNINDENT +.sp +\fB\-h\fP, \fB\-\-help\fP +.INDENT 0.0 +.INDENT 3.5 +show this help message and exit +.UNINDENT +.UNINDENT +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.INDENT 0.0 +.INDENT 3.5 +Causes Ansible to print more debug messages. Adding multiple \-v will increase the verbosity, the builtin plugins currently evaluate up to \-vvvvvv. A reasonable level to start is \-vvv, connection debugging might require \-vvvv. +.UNINDENT +.UNINDENT +.SH ACTIONS +.INDENT 0.0 +.TP +.B \fBcreate\fP +create and open a file in an editor that will be encrypted with the provided vault secret when closed +.sp +\fB\-\-ask\-vault\-password\fP, \fB\-\-ask\-vault\-pass\fP +.INDENT 7.0 +.INDENT 3.5 +ask for vault password +.UNINDENT +.UNINDENT +.sp +\fB\-\-encrypt\-vault\-id\fP \(aqENCRYPT_VAULT_ID\(aq +.INDENT 7.0 +.INDENT 3.5 +the vault id used to encrypt (required if more than one vault\-id is provided) +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-id\fP +.INDENT 7.0 +.INDENT 3.5 +the vault identity to use +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-password\-file\fP, \fB\-\-vault\-pass\-file\fP +.INDENT 7.0 +.INDENT 3.5 +vault password file +.UNINDENT +.UNINDENT +.TP +.B \fBdecrypt\fP +decrypt the supplied file using the provided vault secret +.sp +\fB\-\-ask\-vault\-password\fP, \fB\-\-ask\-vault\-pass\fP +.INDENT 7.0 +.INDENT 3.5 +ask for vault password +.UNINDENT +.UNINDENT +.sp +\fB\-\-output\fP \(aqOUTPUT_FILE\(aq +.INDENT 7.0 +.INDENT 3.5 +output file name for encrypt or decrypt; use \- for stdout +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-id\fP +.INDENT 7.0 +.INDENT 3.5 +the vault identity to use +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-password\-file\fP, \fB\-\-vault\-pass\-file\fP +.INDENT 7.0 +.INDENT 3.5 +vault password file +.UNINDENT +.UNINDENT +.TP +.B \fBedit\fP +open and decrypt an existing vaulted file in an editor, that will be encrypted again when closed +.sp +\fB\-\-ask\-vault\-password\fP, \fB\-\-ask\-vault\-pass\fP +.INDENT 7.0 +.INDENT 3.5 +ask for vault password +.UNINDENT +.UNINDENT +.sp +\fB\-\-encrypt\-vault\-id\fP \(aqENCRYPT_VAULT_ID\(aq +.INDENT 7.0 +.INDENT 3.5 +the vault id used to encrypt (required if more than one vault\-id is provided) +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-id\fP +.INDENT 7.0 +.INDENT 3.5 +the vault identity to use +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-password\-file\fP, \fB\-\-vault\-pass\-file\fP +.INDENT 7.0 +.INDENT 3.5 +vault password file +.UNINDENT +.UNINDENT +.TP +.B \fBview\fP +open, decrypt and view an existing vaulted file using a pager using the supplied vault secret +.sp +\fB\-\-ask\-vault\-password\fP, \fB\-\-ask\-vault\-pass\fP +.INDENT 7.0 +.INDENT 3.5 +ask for vault password +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-id\fP +.INDENT 7.0 +.INDENT 3.5 +the vault identity to use +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-password\-file\fP, \fB\-\-vault\-pass\-file\fP +.INDENT 7.0 +.INDENT 3.5 +vault password file +.UNINDENT +.UNINDENT +.TP +.B \fBencrypt\fP +encrypt the supplied file using the provided vault secret +.sp +\fB\-\-ask\-vault\-password\fP, \fB\-\-ask\-vault\-pass\fP +.INDENT 7.0 +.INDENT 3.5 +ask for vault password +.UNINDENT +.UNINDENT +.sp +\fB\-\-encrypt\-vault\-id\fP \(aqENCRYPT_VAULT_ID\(aq +.INDENT 7.0 +.INDENT 3.5 +the vault id used to encrypt (required if more than one vault\-id is provided) +.UNINDENT +.UNINDENT +.sp +\fB\-\-output\fP \(aqOUTPUT_FILE\(aq +.INDENT 7.0 +.INDENT 3.5 +output file name for encrypt or decrypt; use \- for stdout +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-id\fP +.INDENT 7.0 +.INDENT 3.5 +the vault identity to use +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-password\-file\fP, \fB\-\-vault\-pass\-file\fP +.INDENT 7.0 +.INDENT 3.5 +vault password file +.UNINDENT +.UNINDENT +.TP +.B \fBencrypt_string\fP +encrypt the supplied string using the provided vault secret +.sp +\fB\-\-ask\-vault\-password\fP, \fB\-\-ask\-vault\-pass\fP +.INDENT 7.0 +.INDENT 3.5 +ask for vault password +.UNINDENT +.UNINDENT +.sp +\fB\-\-encrypt\-vault\-id\fP \(aqENCRYPT_VAULT_ID\(aq +.INDENT 7.0 +.INDENT 3.5 +the vault id used to encrypt (required if more than one vault\-id is provided) +.UNINDENT +.UNINDENT +.sp +\fB\-\-output\fP \(aqOUTPUT_FILE\(aq +.INDENT 7.0 +.INDENT 3.5 +output file name for encrypt or decrypt; use \- for stdout +.UNINDENT +.UNINDENT +.sp +\fB\-\-show\-input\fP +.INDENT 7.0 +.INDENT 3.5 +Do not hide input when prompted for the string to encrypt +.UNINDENT +.UNINDENT +.sp +\fB\-\-stdin\-name\fP \(aqENCRYPT_STRING_STDIN_NAME\(aq +.INDENT 7.0 +.INDENT 3.5 +Specify the variable name for stdin +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-id\fP +.INDENT 7.0 +.INDENT 3.5 +the vault identity to use +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-password\-file\fP, \fB\-\-vault\-pass\-file\fP +.INDENT 7.0 +.INDENT 3.5 +vault password file +.UNINDENT +.UNINDENT +.sp +\fB\-n\fP, \fB\-\-name\fP +.INDENT 7.0 +.INDENT 3.5 +Specify the variable name +.UNINDENT +.UNINDENT +.sp +\fB\-p\fP, \fB\-\-prompt\fP +.INDENT 7.0 +.INDENT 3.5 +Prompt for the string to encrypt +.UNINDENT +.UNINDENT +.TP +.B \fBrekey\fP +re\-encrypt a vaulted file with a new secret, the previous secret is required +.sp +\fB\-\-ask\-vault\-password\fP, \fB\-\-ask\-vault\-pass\fP +.INDENT 7.0 +.INDENT 3.5 +ask for vault password +.UNINDENT +.UNINDENT +.sp +\fB\-\-encrypt\-vault\-id\fP \(aqENCRYPT_VAULT_ID\(aq +.INDENT 7.0 +.INDENT 3.5 +the vault id used to encrypt (required if more than one vault\-id is provided) +.UNINDENT +.UNINDENT +.sp +\fB\-\-new\-vault\-id\fP \(aqNEW_VAULT_ID\(aq +.INDENT 7.0 +.INDENT 3.5 +the new vault identity to use for rekey +.UNINDENT +.UNINDENT +.sp +\fB\-\-new\-vault\-password\-file\fP \(aqNEW_VAULT_PASSWORD_FILE\(aq +.INDENT 7.0 +.INDENT 3.5 +new vault password file for rekey +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-id\fP +.INDENT 7.0 +.INDENT 3.5 +the vault identity to use +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-password\-file\fP, \fB\-\-vault\-pass\-file\fP +.INDENT 7.0 +.INDENT 3.5 +vault password file +.UNINDENT +.UNINDENT +.UNINDENT +.SH ENVIRONMENT +.sp +The following environment variables may be specified. +.sp +ANSIBLE_CONFIG \-\- Specify override location for the ansible config file +.sp +Many more are available for most options in ansible.cfg +.sp +For a full list check \fI\%https://docs.ansible.com/\fP\&. or use the \fIansible\-config\fP command. +.SH FILES +.sp +/etc/ansible/ansible.cfg \-\- Config file, used if present +.sp +~/.ansible.cfg \-\- User config file, overrides the default config if present +.sp +\&./ansible.cfg \-\- Local config file (in current working directory) assumed to be \(aqproject specific\(aq and overrides the rest if present. +.sp +As mentioned above, the ANSIBLE_CONFIG environment variable will override all others. +.SH AUTHOR +.sp +Ansible was originally written by Michael DeHaan. +.SH COPYRIGHT +.sp +Copyright © 2018 Red Hat, Inc | Ansible. +Ansible is released under the terms of the GPLv3 license. +.SH SEE ALSO +.sp +\fBansible\fP (1), \fBansible\-config\fP (1), \fBansible\-console\fP (1), \fBansible\-doc\fP (1), \fBansible\-galaxy\fP (1), \fBansible\-inventory\fP (1), \fBansible\-playbook\fP (1), \fBansible\-pull\fP (1), +.sp +Extensive documentation is available in the documentation site: +<\fI\%https://docs.ansible.com\fP>. +IRC and mailing list info can be found in file CONTRIBUTING.md, +available in: <\fI\%https://github.com/ansible/ansible\fP> +.\" Generated by docutils manpage writer. +. diff --git a/docs/man/man1/ansible.1 b/docs/man/man1/ansible.1 new file mode 100644 index 0000000..5f29078 --- /dev/null +++ b/docs/man/man1/ansible.1 @@ -0,0 +1,364 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "ANSIBLE" 1 "" "Ansible 2.14.3" "System administration commands" +.SH NAME +ansible \- Define and run a single task 'playbook' against a set of hosts +.SH SYNOPSIS +.INDENT 0.0 +.TP +.B usage: ansible [\-h] [\-\-version] [\-v] [\-b] [\-\-become\-method BECOME_METHOD] +[\-\-become\-user BECOME_USER] +[\-K | \-\-become\-password\-file BECOME_PASSWORD_FILE] +[\-i INVENTORY] [\-\-list\-hosts] [\-l SUBSET] [\-P POLL_INTERVAL] +[\-B SECONDS] [\-o] [\-t TREE] [\-\-private\-key PRIVATE_KEY_FILE] +[\-u REMOTE_USER] [\-c CONNECTION] [\-T TIMEOUT] +[\-\-ssh\-common\-args SSH_COMMON_ARGS] +[\-\-sftp\-extra\-args SFTP_EXTRA_ARGS] +[\-\-scp\-extra\-args SCP_EXTRA_ARGS] +[\-\-ssh\-extra\-args SSH_EXTRA_ARGS] +[\-k | \-\-connection\-password\-file CONNECTION_PASSWORD_FILE] [\-C] +[\-\-syntax\-check] [\-D] [\-e EXTRA_VARS] [\-\-vault\-id VAULT_IDS] +[\-\-ask\-vault\-password | \-\-vault\-password\-file VAULT_PASSWORD_FILES] +[\-f FORKS] [\-M MODULE_PATH] [\-\-playbook\-dir BASEDIR] +[\-\-task\-timeout TASK_TIMEOUT] [\-a MODULE_ARGS] [\-m MODULE_NAME] +pattern +.UNINDENT +.SH DESCRIPTION +.sp +is an extra\-simple tool/framework/API for doing \(aqremote things\(aq. +this command allows you to define and run a single task \(aqplaybook\(aq against a +set of hosts +.SH COMMON OPTIONS +.INDENT 0.0 +.INDENT 3.5 +host pattern +.UNINDENT +.UNINDENT +.sp +\fB\-\-ask\-vault\-password\fP, \fB\-\-ask\-vault\-pass\fP +.INDENT 0.0 +.INDENT 3.5 +ask for vault password +.UNINDENT +.UNINDENT +.sp +\fB\-\-become\-method\fP \(aqBECOME_METHOD\(aq +.INDENT 0.0 +.INDENT 3.5 +privilege escalation method to use (default=sudo), use \fIansible\-doc \-t become \-l\fP to list valid choices. +.UNINDENT +.UNINDENT +.sp +\fB\-\-become\-password\-file\fP \(aqBECOME_PASSWORD_FILE\(aq, \fB\-\-become\-pass\-file\fP \(aqBECOME_PASSWORD_FILE\(aq +.INDENT 0.0 +.INDENT 3.5 +Become password file +.UNINDENT +.UNINDENT +.sp +\fB\-\-become\-user\fP \(aqBECOME_USER\(aq +.INDENT 0.0 +.INDENT 3.5 +run operations as this user (default=root) +.UNINDENT +.UNINDENT +.sp +\fB\-\-connection\-password\-file\fP \(aqCONNECTION_PASSWORD_FILE\(aq, \fB\-\-conn\-pass\-file\fP \(aqCONNECTION_PASSWORD_FILE\(aq +.INDENT 0.0 +.INDENT 3.5 +Connection password file +.UNINDENT +.UNINDENT +.sp +\fB\-\-list\-hosts\fP +.INDENT 0.0 +.INDENT 3.5 +outputs a list of matching hosts; does not execute anything else +.UNINDENT +.UNINDENT +.sp +\fB\-\-playbook\-dir\fP \(aqBASEDIR\(aq +.INDENT 0.0 +.INDENT 3.5 +Since this tool does not use playbooks, use this as a substitute playbook directory. This sets the relative path for many features including roles/ group_vars/ etc. +.UNINDENT +.UNINDENT +.sp +\fB\-\-private\-key\fP \(aqPRIVATE_KEY_FILE\(aq, \fB\-\-key\-file\fP \(aqPRIVATE_KEY_FILE\(aq +.INDENT 0.0 +.INDENT 3.5 +use this file to authenticate the connection +.UNINDENT +.UNINDENT +.sp +\fB\-\-scp\-extra\-args\fP \(aqSCP_EXTRA_ARGS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify extra arguments to pass to scp only (e.g. \-l) +.UNINDENT +.UNINDENT +.sp +\fB\-\-sftp\-extra\-args\fP \(aqSFTP_EXTRA_ARGS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify extra arguments to pass to sftp only (e.g. \-f, \-l) +.UNINDENT +.UNINDENT +.sp +\fB\-\-ssh\-common\-args\fP \(aqSSH_COMMON_ARGS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand) +.UNINDENT +.UNINDENT +.sp +\fB\-\-ssh\-extra\-args\fP \(aqSSH_EXTRA_ARGS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify extra arguments to pass to ssh only (e.g. \-R) +.UNINDENT +.UNINDENT +.sp +\fB\-\-syntax\-check\fP +.INDENT 0.0 +.INDENT 3.5 +perform a syntax check on the playbook, but do not execute it +.UNINDENT +.UNINDENT +.sp +\fB\-\-task\-timeout\fP \(aqTASK_TIMEOUT\(aq +.INDENT 0.0 +.INDENT 3.5 +set task timeout limit in seconds, must be positive integer. +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-id\fP +.INDENT 0.0 +.INDENT 3.5 +the vault identity to use +.UNINDENT +.UNINDENT +.sp +\fB\-\-vault\-password\-file\fP, \fB\-\-vault\-pass\-file\fP +.INDENT 0.0 +.INDENT 3.5 +vault password file +.UNINDENT +.UNINDENT +.sp +\fB\-\-version\fP +.INDENT 0.0 +.INDENT 3.5 +show program\(aqs version number, config file location, configured module search path, module location, executable location and exit +.UNINDENT +.UNINDENT +.sp +\fB\-B\fP \(aqSECONDS\(aq, \fB\-\-background\fP \(aqSECONDS\(aq +.INDENT 0.0 +.INDENT 3.5 +run asynchronously, failing after X seconds (default=N/A) +.UNINDENT +.UNINDENT +.sp +\fB\-C\fP, \fB\-\-check\fP +.INDENT 0.0 +.INDENT 3.5 +don\(aqt make any changes; instead, try to predict some of the changes that may occur +.UNINDENT +.UNINDENT +.sp +\fB\-D\fP, \fB\-\-diff\fP +.INDENT 0.0 +.INDENT 3.5 +when changing (small) files and templates, show the differences in those files; works great with \-\-check +.UNINDENT +.UNINDENT +.sp +\fB\-K\fP, \fB\-\-ask\-become\-pass\fP +.INDENT 0.0 +.INDENT 3.5 +ask for privilege escalation password +.UNINDENT +.UNINDENT +.sp +\fB\-M\fP, \fB\-\-module\-path\fP +.INDENT 0.0 +.INDENT 3.5 +prepend colon\-separated path(s) to module library (default={{ ANSIBLE_HOME ~ \(dq/plugins/modules:/usr/share/ansible/plugins/modules\(dq }}) +.UNINDENT +.UNINDENT +.sp +\fB\-P\fP \(aqPOLL_INTERVAL\(aq, \fB\-\-poll\fP \(aqPOLL_INTERVAL\(aq +.INDENT 0.0 +.INDENT 3.5 +set the poll interval if using \-B (default=15) +.UNINDENT +.UNINDENT +.sp +\fB\-T\fP \(aqTIMEOUT\(aq, \fB\-\-timeout\fP \(aqTIMEOUT\(aq +.INDENT 0.0 +.INDENT 3.5 +override the connection timeout in seconds (default=10) +.UNINDENT +.UNINDENT +.sp +\fB\-a\fP \(aqMODULE_ARGS\(aq, \fB\-\-args\fP \(aqMODULE_ARGS\(aq +.INDENT 0.0 +.INDENT 3.5 +The action\(aqs options in space separated k=v format: \-a \(aqopt1=val1 opt2=val2\(aq or a json string: \-a \(aq{\(dqopt1\(dq: \(dqval1\(dq, \(dqopt2\(dq: \(dqval2\(dq}\(aq +.UNINDENT +.UNINDENT +.sp +\fB\-b\fP, \fB\-\-become\fP +.INDENT 0.0 +.INDENT 3.5 +run operations with become (does not imply password prompting) +.UNINDENT +.UNINDENT +.sp +\fB\-c\fP \(aqCONNECTION\(aq, \fB\-\-connection\fP \(aqCONNECTION\(aq +.INDENT 0.0 +.INDENT 3.5 +connection type to use (default=smart) +.UNINDENT +.UNINDENT +.sp +\fB\-e\fP, \fB\-\-extra\-vars\fP +.INDENT 0.0 +.INDENT 3.5 +set additional variables as key=value or YAML/JSON, if filename prepend with @ +.UNINDENT +.UNINDENT +.sp +\fB\-f\fP \(aqFORKS\(aq, \fB\-\-forks\fP \(aqFORKS\(aq +.INDENT 0.0 +.INDENT 3.5 +specify number of parallel processes to use (default=5) +.UNINDENT +.UNINDENT +.sp +\fB\-h\fP, \fB\-\-help\fP +.INDENT 0.0 +.INDENT 3.5 +show this help message and exit +.UNINDENT +.UNINDENT +.sp +\fB\-i\fP, \fB\-\-inventory\fP, \fB\-\-inventory\-file\fP +.INDENT 0.0 +.INDENT 3.5 +specify inventory host path or comma separated host list. \-\-inventory\-file is deprecated +.UNINDENT +.UNINDENT +.sp +\fB\-k\fP, \fB\-\-ask\-pass\fP +.INDENT 0.0 +.INDENT 3.5 +ask for connection password +.UNINDENT +.UNINDENT +.sp +\fB\-l\fP \(aqSUBSET\(aq, \fB\-\-limit\fP \(aqSUBSET\(aq +.INDENT 0.0 +.INDENT 3.5 +further limit selected hosts to an additional pattern +.UNINDENT +.UNINDENT +.sp +\fB\-m\fP \(aqMODULE_NAME\(aq, \fB\-\-module\-name\fP \(aqMODULE_NAME\(aq +.INDENT 0.0 +.INDENT 3.5 +Name of the action to execute (default=command) +.UNINDENT +.UNINDENT +.sp +\fB\-o\fP, \fB\-\-one\-line\fP +.INDENT 0.0 +.INDENT 3.5 +condense output +.UNINDENT +.UNINDENT +.sp +\fB\-t\fP \(aqTREE\(aq, \fB\-\-tree\fP \(aqTREE\(aq +.INDENT 0.0 +.INDENT 3.5 +log output to this directory +.UNINDENT +.UNINDENT +.sp +\fB\-u\fP \(aqREMOTE_USER\(aq, \fB\-\-user\fP \(aqREMOTE_USER\(aq +.INDENT 0.0 +.INDENT 3.5 +connect as this user (default=None) +.UNINDENT +.UNINDENT +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.INDENT 0.0 +.INDENT 3.5 +Causes Ansible to print more debug messages. Adding multiple \-v will increase the verbosity, the builtin plugins currently evaluate up to \-vvvvvv. A reasonable level to start is \-vvv, connection debugging might require \-vvvv. +.UNINDENT +.UNINDENT +.SH ENVIRONMENT +.sp +The following environment variables may be specified. +.sp +ANSIBLE_CONFIG \-\- Specify override location for the ansible config file +.sp +Many more are available for most options in ansible.cfg +.sp +For a full list check \fI\%https://docs.ansible.com/\fP\&. or use the \fIansible\-config\fP command. +.SH FILES +.sp +/etc/ansible/ansible.cfg \-\- Config file, used if present +.sp +~/.ansible.cfg \-\- User config file, overrides the default config if present +.sp +\&./ansible.cfg \-\- Local config file (in current working directory) assumed to be \(aqproject specific\(aq and overrides the rest if present. +.sp +As mentioned above, the ANSIBLE_CONFIG environment variable will override all others. +.SH AUTHOR +.sp +Ansible was originally written by Michael DeHaan. +.SH COPYRIGHT +.sp +Copyright © 2018 Red Hat, Inc | Ansible. +Ansible is released under the terms of the GPLv3 license. +.SH SEE ALSO +.sp +\fBansible\-config\fP (1), \fBansible\-console\fP (1), \fBansible\-doc\fP (1), \fBansible\-galaxy\fP (1), \fBansible\-inventory\fP (1), \fBansible\-playbook\fP (1), \fBansible\-pull\fP (1), \fBansible\-vault\fP (1) +.sp +Extensive documentation is available in the documentation site: +<\fI\%https://docs.ansible.com\fP>. +IRC and mailing list info can be found in file CONTRIBUTING.md, +available in: <\fI\%https://github.com/ansible/ansible\fP> +.\" Generated by docutils manpage writer. +. diff --git a/docs/man/man3/.gitdir b/docs/man/man3/.gitdir new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/man/man3/.gitdir |