From 44be69112c71fe65784cc014995044c2a191a449 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Sun, 14 Feb 2021 15:10:15 +0000 Subject: Apply doc fixes by flexibeast and suggestions by Profpatsch&aranea --- AUTHORS | 3 ++- doc/dieshdiedie.html | 6 +++--- doc/el_semicolon.html | 2 +- doc/el_substitute.html | 2 +- doc/elgetpositionals.html | 2 +- doc/execline-shell.html | 4 ++-- doc/execlineb.html | 8 ++++---- doc/exitcodes.html | 6 +++--- doc/export.html | 2 +- doc/fdmove.html | 11 ++++++++--- doc/fdreserve.html | 2 +- doc/getcwd.html | 2 +- doc/getpid.html | 2 +- doc/grammar.html | 4 ++-- doc/index.html | 6 +++--- doc/trap.html | 2 +- 16 files changed, 35 insertions(+), 29 deletions(-) diff --git a/AUTHORS b/AUTHORS index 8bfc182..8a6295b 100644 --- a/AUTHORS +++ b/AUTHORS @@ -7,6 +7,8 @@ Contributors: Eric Le Bihan Rasmus Villemoes Colin Booth + Mira Ressel + Alexis Thanks to: Dan J. Bernstein @@ -18,7 +20,6 @@ Thanks to: Vallo Kallaste Jorge Almeida Olivier Brunel - Mira Ressel Jesse Young Danilo Spinella Éric Vidal skarnet.org

-

Why not just use /bin/sh ?

+

Why not just use /bin/sh?

@@ -175,9 +175,9 @@ genius to understand the simplicity", that's because incompetent people took advantage of the huge Unix flexibility to write insanely crappy or complex software. System administrators can only do a decent job when they understand how the programs they run are supposed to work. People -are slowly starting to grasp this (or are they ? We finally managed +are slowly starting to grasp this (or are they? We finally managed to get rid of sendmail and BIND, but GNU/Linux users seem happy to -welcome the era of D-Bus and systemd. Will we ever learn ?) - but even +welcome the era of D-Bus and systemd. Will we ever learn?) - but even sh, a seemingly simple and basic Unix program, is hard to understand when you lift the cover.

diff --git a/doc/el_semicolon.html b/doc/el_semicolon.html index 31446fe..6519faa 100644 --- a/doc/el_semicolon.html +++ b/doc/el_semicolon.html @@ -112,7 +112,7 @@ produce empty words, which may modify your script's execution flow.

You can use the EXECLINE_STRICT environment variable to check proper block quoting. If that variable contains 1, -commands that read blocks will print a warning message everytime +commands that read blocks will print a warning message every time they find an unquoted argument inside a block. If that variable contains 2 or a bigger integer, commands will print an error message and die on unquoted arguments. diff --git a/doc/el_substitute.html b/doc/el_substitute.html index 3bb56a2..6e6decb 100644 --- a/doc/el_substitute.html +++ b/doc/el_substitute.html @@ -100,7 +100,7 @@ be substituted, or don't be substituted.

  • The default (unquoted) action should be: substitute.
  • A sequence that means "do not substitute" should be able to appear literally. The quote character should also be able to -appear literally before a sequence that means "substitute". (Tricky, eh ?)
    • +appear literally before a sequence that means "substitute". (Tricky, eh?)
  • There should be as few quote characters as possible, to avoid shell-like quoting nightmares.
    • diff --git a/doc/elgetpositionals.html b/doc/elgetpositionals.html index 494a69b..88e7b48 100644 --- a/doc/elgetpositionals.html +++ b/doc/elgetpositionals.html @@ -68,7 +68,7 @@ equivalent to having -P 0.
    • A typical argument-taking execline script will -often begin that way: +often begin this way: 
        #!/command/execlineb
  elgetopt optstring
diff --git a/doc/execline-shell.html b/doc/execline-shell.html
index 80c52eb..92140c1 100644
--- a/doc/execline-shell.html
+++ b/doc/execline-shell.html
@@ -42,12 +42,12 @@ shell with $@ as its argument.
      • execline-shell is meant to be used as the SHELL -environment variable value. It allows one to specify his favourite shell and +environment variable value. It allows one to specify their favourite shell and shell configuration in any language, since the ${HOME}/.execline-shell file can be any executable program. ${HOME}/.execline-shell can be seen as a portable .whateverrc file.
      • As an administrator-modifiable configuration file, execline-shell -provided in execline's examples/etc/ subdirectory, and should be copied by +is provided in execline's examples/etc/ subdirectory, and should be copied by the administrator to /etc.
      diff --git a/doc/execlineb.html b/doc/execlineb.html index da20e4c..fe4f0d3 100644 --- a/doc/execlineb.html +++ b/doc/execlineb.html @@ -65,14 +65,14 @@ exits 0.
      • Pushing the current stack frame. If none of the --p, -P, -S or -s options is set: +-p, -P, -S or -s options are set: execlineb pushes the current positional parameters, i.e. environment variables that start with #, 0, 1, ..., 9. To get the previous values back, use emptyenv -P.
      • Setting the new stack frame. If none of the -P, --S or -s options is set: +-S or -s options are set:
        • execlineb sets the # environment variable to the number n of args it is given.
          • @@ -167,7 +167,7 @@ Quoted closing braces do not have that behaviour. blevel goes below 0 during the parsing, or is not 0 at the end of the script), it exits 100 with an error message.
        • execlineb automatically quotes -blocks. Which means that everytime it +blocks. Which means that every time it finds a word, it prepends it with blevel spaces.
        @@ -196,7 +196,7 @@ force it unset, set to 1, or set to 2 by giving respectively the

        The EXECLINE_STRICT variable (as well as the -q, --w and -W options to execlineb will also modify +-w and -W options to execlineb) will also modify the behaviour of the -S nmin and -s nmin options when execlineb is called with less than nmin positional parameters: diff --git a/doc/exitcodes.html b/doc/exitcodes.html index 619f5d3..c1fcd24 100644 --- a/doc/exitcodes.html +++ b/doc/exitcodes.html @@ -24,7 +24,7 @@ Either C dies normally with an exit code from 0 to 255, or it is killed by a signal. How can we make sure that P reports to G what happened -to C, with as much precision as possible ? +to C, with as much precision as possible?

        @@ -33,7 +33,7 @@ structure filled in by waitpid()) than a process can report by simply exiting. P could exit with the same exit code as C, -but then what should it do if C has been killed by a signal ? +but then what should it do if C has been killed by a signal?

        @@ -42,7 +42,7 @@ but then what should it do if C has been killed by a signal ? But that's actually not right, because P itself could be killed by a signal from another source, and G needs that information. "P has been killed by a signal" and "C has been killed by a signal" are two -different informations, so they should not be reported in the same way. +different pieces of information, so they should not be reported in the same way.

        diff --git a/doc/export.html b/doc/export.html index 1cf9127..06de067 100644 --- a/doc/export.html +++ b/doc/export.html @@ -36,7 +36,7 @@ its arguments.

          -
        • var must be given without a dollar !
          • +
        • var must be given without a dollar!
        • var must not contain the character = .
        diff --git a/doc/fdmove.html b/doc/fdmove.html index 39bdb2b..00a70f0 100644 --- a/doc/fdmove.html +++ b/doc/fdmove.html @@ -46,10 +46,15 @@ instead of moving it; do not close fdfrom.

        • Notes

          -
        • fdmove -c a b prog... is roughly equivalent to -sh -c 'exec prog... a>&b'
        • fdmove a b prog... is roughly equivalent to -sh -c 'exec prog... a>&b b<&-'
          • +sh -c 'exec prog... a>&b b<&-'. +It means: if you write to fd a now, it will have the same effect as writing +to fd b beforehand, and you cannot write to fd b anymore. +
        • fdmove -c a b prog... is roughly equivalent to +sh -c 'exec prog... a>&b'. It means: you can +now write to fd a, and also still write to fd b, and both will have +the same effect as writing to fd b beforehand.
          • +
        • It also works with file descriptors that are open for reading!
        diff --git a/doc/fdreserve.html b/doc/fdreserve.html index 2412b5e..ab9cf59 100644 --- a/doc/fdreserve.html +++ b/doc/fdreserve.html @@ -52,7 +52,7 @@ use: { importas fdr FD0 importas fdw FD1 - } + } piperw $fdr $fdw prog... diff --git a/doc/getcwd.html b/doc/getcwd.html index d3e7e27..62701c6 100644 --- a/doc/getcwd.html +++ b/doc/getcwd.html @@ -50,7 +50,7 @@ line instead of putting it into the environment.

        Notes

          -
        • var must be given without a dollar !
          • +
        • var must be given without a dollar!
        • var must not contain =.
        • Unlike the pwd diff --git a/doc/getpid.html b/doc/getpid.html index 5a849e8..ef1410c 100644 --- a/doc/getpid.html +++ b/doc/getpid.html @@ -47,7 +47,7 @@ line instead of putting it into the environment.

          • Notes

            -
          • var must be given without a dollar !
            • +
          • var must be given without a dollar!
          • var must not contain =.
          diff --git a/doc/grammar.html b/doc/grammar.html index 419c13e..74ee60f 100644 --- a/doc/grammar.html +++ b/doc/grammar.html @@ -69,10 +69,10 @@ and 128 KB on Linux.

          Knowing that, and wanting lightweight and efficient scripts, I wondered: "Why should the interpreter stay in memory while the script -is executing ? Why not parse the script once and for all, put +is executing? Why not parse the script once and for all, put it all into one argv, and just execute into that argv, relying on external commands (which will be called from within the -script) to control the execution flow ?" +script) to control the execution flow?"

          execline was born.

          diff --git a/doc/index.html b/doc/index.html index 8222a48..c3b647b 100644 --- a/doc/index.html +++ b/doc/index.html @@ -17,10 +17,10 @@

          execline

          -

          What is it ?

          +

          What is it?

          - execline is a (non-interactive) scripting language, like sh ; + execline is a (non-interactive) scripting language, like sh - but its syntax is quite different from a traditional shell syntax. The execlineb program is meant to be used as an interpreter for a text file; the other commands are essentially useful inside an @@ -38,7 +38,7 @@ shell's syntax, and has no security issues.

          diff --git a/doc/trap.html b/doc/trap.html index 1a6e9df..9351c93 100644 --- a/doc/trap.html +++ b/doc/trap.html @@ -86,7 +86,7 @@ this option does nothing. importas ! ! to retrieve the pid of prog in $!. If they need the signal number, which can be the case in default directives, they can for instance use -multisubstitute { importas ! ! importas SIGNAL SIGNAL } +multisubstitute { importas ! ! importas SIGNAL SIGNAL } to get both $! and $SIGNAL substitutions.
        • The -x option is basically a shortcut for a default { multisubstitute { importas ! ! importas SIGNAL SIGNAL } kill -$SIGNAL $! } directive.
          • -- cgit v1.2.3