minor documentation improvements

[fcscs/fcscs.git] / bin / fcscs

diff --git a/bin/fcscs b/bin/fcscs
index e0a34f919fb61fde4c3016fa4e009228eb53038c..b2bef5d38dc0ae6d372fdc28bbabdd4c14b6d7d1 100755 (executable)
--- a/bin/fcscs
+++ b/bin/fcscs
@@ -54,6 +54,28 @@ None so far.
 
 =head1 USAGE
 
 
 =head1 USAGE
 

+Short overview of the general usage, details below:
+
+    - start fcscs
+    - configure actions (optional)
+        - enable pasting
+        - ...
+    - select mode (optional, URL mode is used on startup):
+        - f: file paths
+        - u: URLs
+        - ...
+        - /: search mode
+    - for `normal' modes:
+        - select match by displayed number or <return> for lowest numbered
+          match
+        - configured action is run, e.g. URL is opened with browser
+    - for `search' mode:
+        - perform incremental search
+        - on <return> go to `normal' mode to select a match
+        - after the match is selected wait for confirmation or extension
+        - confirmation: <return> run previously selected action
+        - extension: change match, e.g. select complete word or line
+

 GNU Screen setup (add to F<~/.screenrc>):
 
     bind ^B eval "hardcopy $HOME/.tmp/screen-fcscs" "screen fcscs $HOME/.tmp/screen-fcscs"
 GNU Screen setup (add to F<~/.screenrc>):
 
     bind ^B eval "hardcopy $HOME/.tmp/screen-fcscs" "screen fcscs $HOME/.tmp/screen-fcscs"


@@ -87,10 +109,9 @@ explained below. Per default URLs are selected, see options for a way to
 change this.
 
 I<NOTE>: When yanking (copying) a temporary file is used to pass the data to
 change this.
 
 I<NOTE>: When yanking (copying) a temporary file is used to pass the data to

-GNU screen/Tmux without exposing it to C<ps ux> or C<top>. However this may
+GNU screen/Tmux without exposing it to C<ps aux> or C<top>. However this may

 leak data if those temporary files are written to disk. To prevent this change
 leak data if those temporary files are written to disk. To prevent this change

-your C<$TMP> accordingly to point to a memory-only location or encrypted
-storage.
+your C<$TMP> to point to a memory-only location or encrypted storage.

 
 If no window appears, try running B<fcscs> manually to catch the error message
 and please report the bug:
 
 If no window appears, try running B<fcscs> manually to catch the error message
 and please report the bug:


@@ -1089,7 +1110,7 @@ my %setting = (
 
 =over
 
 
 =over
 

-=item B<url> used by C<\&mapping_mode_url()>
+=item B<url>  used by C<\&mapping_mode_url()>

 
 =item B<path> used by C<\&mapping_mode_path()>
 
 
 =item B<path> used by C<\&mapping_mode_path()>