Re: PATCH: README

Re: PATCH: README

[Peter Stephenson]

Sven Wischnowsky wrote:
> P.S.: "...and will most likely not feel like altering them (or, in
>       some cases, even reading them, unless you are a shell wizard)",
>       is it really that... erm... bad? overwhelming? complicated?
>       badly written?

The (small amount of) feedback so far seems to suggest that people who
weren't born reading shell scripts find this stuff hard to understand.  I
didn't want to put anyone off from using it just because it looks hard.
Maybe the message can be made more developer-friendly.

--- Completion/README~	Mon Mar  1 14:10:36 1999
+++ Completion/README	Mon Mar  1 14:15:14 1999
@@ -17,8 +17,9 @@
 
 Core:
   The basic functions and files to be sourced.  You will certainly need
-  these, and will most likely not feel like altering them (or, in some
-  cases, even reading them, unless you are a shell wizard).  The files are:
+  these, and will most likely not want to alter them --- if you do, it
+  would probably help to give your version a different name.  The files
+  are:
   compinit
     As already described, this is not a function, but is sourced once
     (with the `source' or `.' commands) to set up the completion system.


-- 
Peter Stephenson <pws@ibmth.df.unipi.it>       Tel: +39 050 844536
WWW:  http://www.ifh.de/~pws/
Dipartimento di Fisica, Via Buonarroti 2, 56127 Pisa, Italy

PATCH: README

[Sven Wischnowsky]

Just some typos and documentation for the new ones in Base.

Bye
 Sven

P.S.: "...and will most likely not feel like altering them (or, in
      some cases, even reading them, unless you are a shell wizard)",
      is it really that... erm... bad? overwhelming? complicated?
      badly written?


--- oc/README	Mon Mar  1 10:10:07 1999
+++ Completion/README	Mon Mar  1 14:19:07 1999
@@ -11,7 +11,7 @@
   [[ -f ~/completion/compinit ]] && . ~/completion/compinit -d
 This will rebind any keys which do completion to use the new system.
 For more detailed instructions, including how to add new completions, see
-the top of Core/compinit .
+the top of Core/compinit.
 
 The subdirectories contain:
 
@@ -46,7 +46,7 @@
     it is wider than just command+argument.)
   _path_files
     The function usually called to complete filenames and directories.  It
-    replaces the standard -f and -/ options for the basic completion
+    replaces the standard -f, -g and -/ options for the basic completion
     commands:  it can do various extra tricks, such as expanding a whole
     path at once, e.g. F/C/C/_p<TAB> -> Functions/Completion/Core/_path_files
 Base:
@@ -65,22 +65,29 @@
     as you wish.
   _match_pattern
   _match_test
-    These are used by Base/_path_files (and hence also Base/_files) for
-    file completion with control over matching (whether to complete
-    case-insensitively, or to allow insertion before `.', etc.)  See
-    _match_test for instructions.  Note _path_files expects these files
-    to be present.
+    These are used by Base/_path_files (and hence also Base/_files)
+    and Base/_comp_parts for file completion with control over
+    matching (whether to complete case-insensitively, or to allow
+    insertion before `.', etc.)  See _match_test for instructions.
+    Note _path_files expects these files to be present.
   _precommand
     Allows completion when the first word on the line has to be ignored,
     for example `noglob ...' should ignore the noglob and just complete
     as if it wasn't there.  Add other such commands to the top line.
   _redirect
-    Completes after `<' or `<': this version calls _files.
+    Completes after `<' or `>': this version calls _files.
   _subscript
     For completion in subscripts of parameters, e.g $foo[...].
   _vars
     Completion for commands which need variables (so this could also be in
     the Builtins directory), but also in math environments such as ((...)).
+  _tilde
+    Completion after `~', defaults to user names and named directories.
+  _equal
+    Completion after `=', normally command and alias names are used.
+  _parameter
+  _brace_parameter
+    For completion inside parameter expansions ($... and ${...).
 Builtins:
   Define completions for various shell builtins.  The top line of each file
   says which builtins they apply to; in many cases you can guess from the

--
Sven Wischnowsky                         wischnow@informatik.hu-berlin.de