Skip to content

Commit 2cd94ad

Browse files
committed
Update help message
1 parent 47c758a commit 2cd94ad

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

manage-ghar

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Optional arguments:
120120
-r RUNNER_COMMAND
121121
Command to execute instead of running the runner directly. This command should not take any argument.
122122
-f
123-
Force start even if the runner is running.
123+
Force start even if the runner is running (may have unpredictable effects).
124124
-v
125125
Show current version and return.
126126
-h
@@ -139,12 +139,17 @@ Subcommands:
139139
Mandatory arguments:
140140
RUNNER_PATH
141141
Path to a GitHub Actions Runner directory.
142+
EOF
143+
}
144+
145+
usage_extra () {
146+
cat <<EOF
142147
143148
If there is a configuration file $CONFIG_FILE in the user home directory, then manage-ghar will use it to set the default value of the following optional arguments:
144149
state_path
145150
runner_command
146-
force
147-
Arguments must be in the form "<key>=<value>". Arguments from the command line have a higher priority.
151+
force (true or false)
152+
Arguments must be in the form "<key>=<value>". Arguments from the command line override those default values.
148153
EOF
149154
}
150155

@@ -170,6 +175,7 @@ main () {
170175
case $option in
171176
"h")
172177
usage
178+
usage_extra
173179
return 0
174180
;;
175181
"v")

0 commit comments

Comments
 (0)