diff options
Diffstat (limited to 'docs/man/man1/ansible-config.1')
| -rw-r--r-- | docs/man/man1/ansible-config.1 | 203 |
1 files changed, 203 insertions, 0 deletions
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. +. |