add alien filter, trigger updates

1 files changed, 39 insertions, 32 deletions

diff --git a/src/frontend/cli/README.md b/src/frontend/cli/README.md
index 54fc628..0ef8b69 100644
--- a/src/frontend/cli/README.md
+++ b/src/frontend/cli/README.md
@@ -60,9 +60,13 @@ The remote can be selected by using the --remote option.
 
 * Examples:
 
-    branch master --remote=gitlab   # pull the branch 'master' from gitlab.com
 
-    branch next --remote=pagure     # pull the branch 'next' from pagure.io
+`    branch master --remote=gitlab   # pull the branch 'master' from gitlab.com
+`
+
+`    branch next --remote=pagure     # pull the branch 'next' from pagure.io
+`
+
 
 !!! WARNING !!!
 
@@ -72,17 +76,22 @@ Branch 'master' must be paired with the stable binary repository (odd numbers in
 
 * Examples:
 
-    sisyphus mirror set 1
+`    sisyphus mirror set 1
+`
 
-    sisyphus mirror set 5
+`    sisyphus mirror set 5
+`
 
 Branch 'next' must be paired with the testing binary repository (even numbers in 'sisyphus mirror list').
 
 * Examples:
 
-    sisyphus mirror set 2
+`    sisyphus mirror set 2
+`
+
+`    sisyphus mirror set 8
+`
 
-    sisyphus mirror set 8
 
 **Usage**:
 
@@ -103,11 +112,11 @@ Use the --ebuild option to install ebuild(source) packages.
 
 * Examples:
 
-    sisyphus install pidgin
+`    sisyphus install pidgin`
 
 will install pidgin binary package (if available); if there is none, but the ebuild(source) package for pidgin is found, it will stop and suggest the --ebuild option.
 
-    sisyphus install pidgin --ebuild
+`    sisyphus install pidgin --ebuild`
 
 will compile pidgin from source
 
@@ -218,35 +227,37 @@ In addition, search can be performed by package description, using the -d (--des
 
 (use single or double quotes when the description contains spaces)
 
-Use the -s (--state) filters to select only packages of interest. Possible values:
+Use the -f (--filter) option to select only packages of interest. Possible values:
 
-    all (default) - search the entire database
+    any (default) - search the entire database
 
-    installed - search in all installed packages
-
-    local - search for installed packages but not available
+    alien - search for installed packages but not available
     (this filter can match packages installed from e-builds or packages no longer maintained as binaries)
 
+    installed - search in all installed packages
+
     remote - search for available packages but not installed
 
     upgrade - search for installed packages where installed version is different from available version
 
-!!! NOTE !!! bash will expand a single * character as current folder listing.
-To search for all '--state' packages escape it, or surround it with quotes, or use an empty string:
+!!! NOTE !!!:
+
+bash will expand a single * character as current folder listing.
+To search for all matching '--filter' packages escape it, or surround it with quotes, or use an empty string:
 
-    sisyphus search * -s installed          # this is not valid!
+    sisyphus search * -f installed          # this is not valid!
 
-    sisyphus search \* -s local             # OK
+    sisyphus search \* -f alien             # OK
 
-    sisyphus search '*' -s remote           # OK
+    sisyphus search '*' -f remote           # OK
 
-    sisyphus search '' -s upgrade           # OK
+    sisyphus search '' -f upgrade           # OK
 
 
 To search for all (including source) packages, use the --ebuild option.
 This is slower since will perform an emerge --search actually.
 With this option, more than one package can be provided as search term.
-'-d', '-s' and '-q' (quiet) options are ignored in this mode.
+'-d', '-f' and '-q' (quiet) options are ignored in this mode.
 
 **Usage**:
 
@@ -257,7 +268,7 @@ $ sisyphus search [OPTIONS] PACKAGE...
 **Options**:
 
 * `-d, --description TEXT`: Match description.
-* `-s, --state [all|installed|local|remote|upgrade]`: [default: all]
+* `-f, --filter [any|alien|installed|remote|upgrade]`: [default: any]
 * `-q`: Short (one line) output.
 * `-e, --ebuild`: Search in ebuilds (slower).
 * `--help`: Show this message and exit.
@@ -301,12 +312,10 @@ This will not allways be possible, as the reverse dependency chain may be way to
 
 * Examples:
 
-    sisyphus uninstall firefox
-
-will succeed, nothing depends on it
-
-    sisyphus uninstall pulseaudio
+`   sisyphus uninstall firefox`
+will succeed, nothing depends on it 
 
+`    sisyphus uninstall pulseaudio`
 will fail, many packages depend on it
 
 With --force option, packages are uninstalled *UNSAFELY* by ignoring reverse dependencies.
@@ -316,12 +325,10 @@ Upgrading the system may pull the packages back in, to fix the reverse dependenc
 
 * Examples :
 
-    sisyphus uninstall pulseaudio --force
-
+`    sisyphus uninstall pulseaudio --force`
 will succeed, but you may no longer have audio
 
-    sisyphus uninstall openrc --force
-
+`    sisyphus uninstall openrc --force`
 will succeed, but the system will be broken
 
 **Usage**:
@@ -358,11 +365,11 @@ Use the --ebuild option to upgrade **EVERYTHING**, binary and/or ebuild(source)
 
 * Examples:
 
-    sisyphus upgrade
+`    sisyphus upgrade`
 
 will upgrade the system using binary packages; if any ebuild(source) package upgrade is detected, it will stop and suggest the --ebuild option
 
-    sisyphus upgrade --ebuild
+`    sisyphus upgrade --ebuild`
 
 will upgrade the system using both binary and/or ebuild(source) packages