Oben Sonne avatar Oben Sonne committed 406e3c5

Doc update

Comments (0)

Files changed (2)

     $ install gnome-encfs /usr/local/bin
     
 **Note:** You can run *gnome-encfs* right from the extracted package but to make
-use of the automount feature at GNOME login, it must be placed in your *PATH*
-as it is configured during a login to GNOME. Using the install command above
+use of the automount feature at GNOME login, it must be placed in somewhere
+*PATH* (as configured during a login to GNOME). Using the install command above
 ensures this requirement is fulfilled.
 
 Usage
 `~/Private`.
 
     $ gnome-encfs -a ~/.Private.encrypted ~/Private
-    > EncFS password: <enter encfs password>
-    > Mount at login [Y/n]: <say 'y' or 'n'>
+    EncFS password: <enter encfs password>
+    Mount at login [Y/n]: <say 'y' or 'n'>
     
-This adds the encfs path, its mount location and password to the GNOME keyring
-and sets up a GNOME autostart item to mount it at GNOME login (if enabled).  
+This adds the EncFS path, its mount location and password to the GNOME keyring
+and sets up a GNOME autostart entry to mount it at GNOME login (if enabled).
 
 ### Mount an EncFS folder
 
 which looks up the password in the keyring and does the mounting without
 the need to enter the password manually.
 
-### Other stuff
+### Other tasks
 
-You can also  show, edit and remove EncFS folders handled by *gnome-enfs*.
-Inspect
+You can also  show, edit and remove EncFS folders handled by *gnome-enfs*:
 
-    $ gnome -h
+    $ gnome-encfs -h
+    Usage: gnome-encfs --list
+           gnome-encfs --mount [ENCFS-PATH-or-MOUNT-POINT]
+           gnome-encfs --add ENCFS-PATH MOUNT-POINT
+           gnome-encfs --edit MOUNT-POINT
+           gnome-encfs --remove MOUNT-POINT
     
-for some instructions. Usage should be straight forward - if not,
-[submit an issue][7].
+    Painlessly mount and manage EncFS folders using GNOME's keyring.
+    
+    Options:
+      --version            show program's version number and exit
+      -h, --help           show this help message and exit
+      -l, --list           list all EncFS items stored in keyring
+      -m, --mount          mount all or selected EncFS paths stored in keyring
+      -a, --add            add a new EncFS item to keyring
+      -e, --edit           edit an EncFS item in keyring
+      -r, --remove         remove an EncFS item from keyring
+    ...
+    
+Usage should be straight forward - otherwise [submit an issue][7].
 
 License
 -------
 
 [1]: http://www.arg0.net/encfs
 [2]: http://live.gnome.org/GnomeKeyring
-[3]: 
+[3]: http://bitbucket.org/obensonne/gnome-encfs/get/tip.tar.gz
 [4]: 
 [5]: http://dropbox.com
 [6]: http://www.gnu.org/licenses/gpl.html
 
 USAGE = """Usage: %prog --list
        %prog --mount [ENCFS-PATH-or-MOUNT-POINT]
-       %prog --add ENCFS-PATH MOUNT-POINT [--login-mount]
+       %prog --add ENCFS-PATH MOUNT-POINT
        %prog --edit MOUNT-POINT
        %prog --remove MOUNT-POINT"""
        
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.