File: fab.1

package info (click to toggle)
fabric 3.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 988 kB
  • sloc: python: 4,816; makefile: 8
file content (105 lines) | stat: -rw-r--r-- 2,764 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH FABRIC "1" "August 2025" "Fabric 2.6.0" "User Commands"
.SH NAME
Fabric \- manual page for Fabric 2.6.0
.SH SYNOPSIS
.B fab
[\fI\,--core-opts\/\fR] \fI\,task1 \/\fR[\fI\,--task1-opts\/\fR] ... \fI\,taskN \/\fR[\fI\,--taskN-opts\/\fR]
.SH DESCRIPTION
Core options:
.TP
\fB\-\-complete\fR
Print tab\-completion candidates for given
parse remainder.
.TP
\fB\-\-hide\fR=\fI\,STRING\/\fR
Set default value of run()'s 'hide' kwarg.
.TP
\fB\-\-no\-dedupe\fR
Disable task deduplication.
.TP
\fB\-\-print\-completion\-script\fR=\fI\,STRING\/\fR
Print the tab\-completion script for your
preferred shell (bash|zsh|fish).
.TP
\fB\-\-prompt\-for\-login\-password\fR
Request an upfront SSH\-auth password
prompt.
.TP
\fB\-\-prompt\-for\-passphrase\fR
Request an upfront SSH key passphrase
prompt.
.TP
\fB\-\-prompt\-for\-sudo\-password\fR
Prompt user at start of session for the
sudo.password config value.
.TP
\fB\-\-write\-pyc\fR
Enable creation of .pyc files.
.TP
\fB\-c\fR STRING, \fB\-\-collection\fR=\fI\,STRING\/\fR
Specify collection name to load.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Enable debug output.
.TP
\fB\-D\fR INT, \fB\-\-list\-depth\fR=\fI\,INT\/\fR
When listing tasks, only show the first
INT levels.
.TP
\fB\-e\fR, \fB\-\-echo\fR
Echo executed commands before running.
.TP
\fB\-f\fR STRING, \fB\-\-config\fR=\fI\,STRING\/\fR
Runtime configuration file to use.
.TP
\fB\-F\fR STRING, \fB\-\-list\-format\fR=\fI\,STRING\/\fR
Change the display format used when
listing tasks. Should be one of: flat
(default), nested, json.
.TP
\fB\-h\fR [STRING], \fB\-\-help\fR[=\fI\,STRING\/\fR]
Show core or per\-task help and exit.
.TP
\fB\-H\fR STRING, \fB\-\-hosts\fR=\fI\,STRING\/\fR
Comma\-separated host name(s) to execute
tasks against.
.TP
\fB\-i\fR, \fB\-\-identity\fR
Path to runtime SSH identity (key) file.
May be given multiple times.
.TP
\fB\-l\fR [STRING], \fB\-\-list\fR[=\fI\,STRING\/\fR]
List available tasks, optionally limited
to a namespace.
.TP
\fB\-p\fR, \fB\-\-pty\fR
Use a pty when executing shell commands.
.TP
\fB\-r\fR STRING, \fB\-\-search\-root\fR=\fI\,STRING\/\fR
Change root directory used for finding
task modules.
.TP
\fB\-R\fR, \fB\-\-dry\fR
Echo commands instead of running.
.TP
\fB\-S\fR STRING, \fB\-\-ssh\-config\fR=\fI\,STRING\/\fR
Path to runtime SSH config file.
.TP
\fB\-t\fR INT, \fB\-\-connect\-timeout\fR=\fI\,INT\/\fR
Specifies default connection timeout, in
seconds.
.TP
\fB\-T\fR INT, \fB\-\-command\-timeout\fR=\fI\,INT\/\fR
Specify a global command execution
timeout, in seconds.
.TP
\fB\-V\fR, \fB\-\-version\fR
Show version and exit.
.TP
\fB\-w\fR, \fB\-\-warn\-only\fR
Warn, instead of failing, when shell
commands fail.
.PP
Paramiko 3.5.1
Invoke 2.2.0