add short overview to usage documentation
authorSimon Ruderich <simon@ruderich.org>
Sun, 24 Jan 2016 19:41:07 +0000 (20:41 +0100)
committerSimon Ruderich <simon@ruderich.org>
Sun, 24 Jan 2016 19:41:07 +0000 (20:41 +0100)
bin/fcscs

index e0a34f919fb61fde4c3016fa4e009228eb53038c..f561af237ce9ec8dc77289268ed18288e0ae4e7c 100755 (executable)
--- a/bin/fcscs
+++ b/bin/fcscs
@@ -54,6 +54,28 @@ None so far.
 
 =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"