aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorRahiel Kasim <rahielkasim@gmail.com>2017-05-25 11:41:04 +0200
committerRahiel Kasim <rahielkasim@gmail.com>2017-05-25 11:42:58 +0200
commit4de0379fe53a846a289e21be871626527be9a581 (patch)
treea6f8c9883781b95556e539dd4d828bc881b47b01
parent3766e86ca6ba8602a2d35eb944ae8d091ed8490e (diff)
README: minimum Firejail version to ship with firecfg, firejail -> Firejail
-rw-r--r--README.md28
1 files changed, 16 insertions, 12 deletions
diff --git a/README.md b/README.md
index dff4db9..d49e9cd 100644
--- a/README.md
+++ b/README.md
@@ -3,9 +3,10 @@ Firectl
[![License](https://img.shields.io/badge/License-GPLv2+-blue.svg)](https://github.com/rahiel/firectl/blob/master/LICENSE.txt)
[![Downloads](https://img.shields.io/github/downloads/rahiel/firectl/total.svg)](https://github.com/rahiel/firectl/releases)
+[![pyversions](https://img.shields.io/pypi/pyversions/firectl.svg)](https://pypi.python.org/pypi/firectl)
-Firectl is a tool to integrate [firejail](https://firejail.wordpress.com/)
-sandboxing in the Linux desktop. Enable firejail for an application and enjoy a
+Firectl is a tool to integrate [Firejail](https://firejail.wordpress.com/)
+sandboxing in the Linux desktop. Enable Firejail for an application and enjoy a
more secure desktop.
# Usage
@@ -15,28 +16,31 @@ To see which applications you can enable:
firectl status
```
-To enable firejail for a program:
+To enable Firejail for a program:
``` bash
sudo firectl enable firefox
```
-To disable firejail for a program:
+To disable Firejail for a program:
``` bash
sudo firectl disable firefox
```
-After enabling a program, it will start within a firejail when launched via the
+After enabling a program, it will start within a Firejail when launched via the
menu or the file manager. To test if it's working: open a terminal and execute
-`watch firejail --list`. This lists all active firejail sandboxes. Then start an
+`watch firejail --list`. This lists all active Firejail sandboxes. Then start an
enabled application and look for it in that terminal. Note that applications
-launched from the terminal or from scripts will not be in a firejail, unless
+launched from the terminal or from scripts will not be in a Firejail, unless
explicitly done so.
# Alternative
-Firectl was made before Firejail had its own tool for desktop integration. Now
-firejail ships with a tool called `firecfg`. Look at its manual: `man firecfg`
-and decide if you still need firectl or if firecfg is enough.
+Firectl was made before Firejail had its own tool for desktop integration.
+Firejail 0.9.40+ ships with a tool called `firecfg`. Look at
+the [Linux Mint Sandboxing Guide][] and the manual: `man firecfg` and decide if
+you still need firectl or if firecfg is enough.
+
+[Linux Mint Sandboxing Guide]: https://firejail.wordpress.com/2017/05/15/linux-mint-sandboxing-guide/#launchers
# Debian/Ubuntu
@@ -50,11 +54,11 @@ For Debian and Ubuntu systems install the deb at
Firectl works by modifying the system's desktop files, the files that tell the
system which user applications are installed and how to run them. When these
applications are updated, the desktop files are also updated, disabling
-firejail. The firectl settings need to be restored. (Note that for Debian/Ubuntu
+Firejail. The firectl settings need to be restored. (Note that for Debian/Ubuntu
systems, installing the deb file takes care of this and no manual restoring is
necessary.)
-For now you have to manually restore firejail settings after upgrades:
+For now you have to manually restore Firejail settings after upgrades:
``` bash
sudo firectl restore
```