diff options
author | 2022-11-03 13:04:45 -0300 | |
---|---|---|
committer | 2022-11-04 15:57:17 -0300 | |
commit | f03d98649788243d4f47b340858a08e8f0d0dc8c (patch) | |
tree | e4be24e51842ca8abdcaed579a446587292fe357 /src/man/firejail-profile.txt | |
parent | RELNOTES: add build: Fix musl warnings (diff) | |
download | firejail-f03d98649788243d4f47b340858a08e8f0d0dc8c.tar.gz firejail-f03d98649788243d4f47b340858a08e8f0d0dc8c.tar.zst firejail-f03d98649788243d4f47b340858a08e8f0d0dc8c.zip |
docs: clarify that --appimage should appear before --profile
And fix the argument order in the examples to reflect that.
Background: The order in which these options appeared in the
documentation was inconsistent. src/man/firejail.txt used --appimage
before --profile and src/man/firejail-profile.txt used --profile before
--appimage. Then commit 44fefcac0 ("Make appimage examples consistent
with --appimage option short description", 2022-10-05) / PR #5402 was
made, which standardized on --profile before --appimage in both places.
But as mentioned by @rusty-snake[1], --appimage has be specified before
--profile in order for any `?HAS_APPIMAGE` conditionals inside of the
profile to evaluate to true.
So change the documentation to use and recommend the latter form.
Also, add --quiet to one example to make it clear that --appimage does
not have to be the first option (nor the last option before --profile).
[1] https://github.com/netblue30/firejail/pull/5402#issuecomment-1274889618
Diffstat (limited to 'src/man/firejail-profile.txt')
-rw-r--r-- | src/man/firejail-profile.txt | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/src/man/firejail-profile.txt b/src/man/firejail-profile.txt index 138aae8af..7fa677ae5 100644 --- a/src/man/firejail-profile.txt +++ b/src/man/firejail-profile.txt | |||
@@ -14,7 +14,7 @@ Using a specific profile: | |||
14 | .br | 14 | .br |
15 | Example: | 15 | Example: |
16 | .br | 16 | .br |
17 | $ firejail --profile=/etc/firejail/kdenlive.profile --appimage kdenlive.appimage | 17 | $ firejail --appimage --profile=/etc/firejail/kdenlive.profile kdenlive.appimage |
18 | .br | 18 | .br |
19 | 19 | ||
20 | .br | 20 | .br |
@@ -25,7 +25,7 @@ $ firejail --profile=/etc/firejail/kdenlive.profile --appimage kdenlive.appimage | |||
25 | .br | 25 | .br |
26 | Example: | 26 | Example: |
27 | .br | 27 | .br |
28 | $ firejail --profile=kdenlive --appimage kdenlive.appimage | 28 | $ firejail --appimage --profile=kdenlive kdenlive.appimage |
29 | .br | 29 | .br |
30 | 30 | ||
31 | .br | 31 | .br |
@@ -179,6 +179,11 @@ can be enabled or disabled globally in Firejail's configuration file. | |||
179 | 179 | ||
180 | The profile line may be any profile line that you would normally use in a profile \fBexcept\fR for "quiet" and "include" lines. | 180 | The profile line may be any profile line that you would normally use in a profile \fBexcept\fR for "quiet" and "include" lines. |
181 | 181 | ||
182 | Note: When using one or more conditionals and \fB--profile\fR, it is | ||
183 | recommended that the relevant option(s) (such as \fB--appimage\fR) be specified | ||
184 | before \fB--profile\fR, so that their respective conditional(s) (such as | ||
185 | \fB?HAS_APPIMAGE\fR) inside of the profile evaluate to true. | ||
186 | |||
182 | .TP | 187 | .TP |
183 | \fBinclude other.profile | 188 | \fBinclude other.profile |
184 | Include other.profile file. | 189 | Include other.profile file. |