--- a/adopt/usage/index.html Fri May 17 23:28:21 2019 -0400
+++ b/adopt/usage/index.html Sat May 18 13:34:09 2019 -0400
@@ -407,8 +407,7 @@
</pre></div>
-<p>This is a typical way to use Adopt. There are three functions important
-functions here:</p>
+<p>This is a typical way to use Adopt. There are three important functions here:</p>
<ul>
<li>The <code>toplevel</code> function takes care of parsing arguments and exiting with an
appropriate status code if necessary.</li>
@@ -689,10 +688,10 @@
<span class="p">(</span><span class="nb">defparameter</span> <span class="vg">*option-no-literal*</span>
<span class="p">(</span><span class="nv">adopt:make-option</span> <span class="ss">'no-literal</span>
+ <span class="ss">:result-key</span> <span class="ss">'literal</span>
<span class="ss">:help</span> <span class="s">"treat PATTERN as a regex (the default)"</span>
<span class="ss">:long</span> <span class="s">"no-literal"</span>
<span class="ss">:short</span> <span class="sc">#\L</span>
- <span class="ss">:result-key</span> <span class="ss">'literal</span>
<span class="ss">:reduce</span> <span class="p">(</span><span class="nb">constantly</span> <span class="no">nil</span><span class="p">)))</span>
<span class="p">(</span><span class="nb">defparameter</span> <span class="vg">*option-case-sensitive*</span>
@@ -725,19 +724,20 @@
<span class="ss">:reduce</span> <span class="p">(</span><span class="nb">constantly</span> <span class="no">nil</span><span class="p">)))</span>
<span class="p">(</span><span class="nb">defparameter</span> <span class="vg">*option-context*</span>
- <span class="p">(</span><span class="nv">adopt:make-option</span> <span class="ss">'context</span>
+ <span class="p">(</span><span class="nv">adopt:make-option</span> <span class="ss">'color</span>
<span class="ss">:parameter</span> <span class="s">"N"</span>
<span class="ss">:help</span> <span class="s">"show N lines of context (default 0)"</span>
<span class="ss">:long</span> <span class="s">"context"</span>
- <span class="ss">:short</span> <span class="sc">#\U</span>
+ <span class="ss">:short</span> <span class="sc">#\u</span>
<span class="ss">:initial-value</span> <span class="mi">0</span>
<span class="ss">:reduce</span> <span class="nf">#'</span><span class="nv">adopt:last</span>
<span class="ss">:key</span> <span class="nf">#'</span><span class="nb">parse-integer</span><span class="p">))</span>
+
<span class="p">(</span><span class="nb">defparameter</span> <span class="vg">*group-matching*</span>
<span class="p">(</span><span class="nv">adopt:make-group</span> <span class="ss">'matching-options</span>
<span class="ss">:title</span> <span class="s">"Matching Options"</span>
- <span class="ss">:help</span> <span class="s">"These options affect how lines are matched."</span>
+ <span class="c1">;; :help "These options affect how lines are matched."</span>
<span class="ss">:options</span> <span class="p">(</span><span class="nb">list</span> <span class="vg">*option-literal*</span>
<span class="vg">*option-no-literal*</span>
<span class="vg">*option-case-sensitive*</span>
@@ -746,11 +746,12 @@
<span class="p">(</span><span class="nb">defparameter</span> <span class="vg">*group-output*</span>
<span class="p">(</span><span class="nv">adopt:make-group</span> <span class="ss">'output-options</span>
<span class="ss">:title</span> <span class="s">"Output Options"</span>
- <span class="ss">:help</span> <span class="s">"These options affect how matching lines are printed."</span>
+ <span class="ss">:help</span> <span class="s">"These options affect how matching lines are printed. The defaults are ideal for piping into other programs."</span>
<span class="ss">:options</span> <span class="p">(</span><span class="nb">list</span> <span class="vg">*option-color*</span>
<span class="vg">*option-no-color*</span>
<span class="vg">*option-context*</span><span class="p">)))</span>
+
<span class="p">(</span><span class="nv">adopt:define-string</span> <span class="vg">*help-text*</span>
<span class="s">"Search FILEs for lines that match the regular expression ~</span>
<span class="s"> PATTERN and print them to standard out. Several options ~</span>
@@ -771,6 +772,7 @@
</pre></div>
+<p>(adopt:print-help <em>ui</em> :width 60 :option-width 16)</p>
<p>And with all that out of the way, you've got some nicely-organized help text
for your users:</p>
<div class="codehilite"><pre><span/><span class="p">(</span><span class="nv">adopt:print-help</span> <span class="vg">*ui*</span> <span class="ss">:width</span> <span class="mi">60</span> <span class="ss">:option-width</span> <span class="mi">16</span><span class="p">)</span>
@@ -799,9 +801,13 @@
<span class="c1">; ignore case when matching</span>
<span class="c1">;</span>
<span class="c1">; Output Options:</span>
+<span class="c1">;</span>
+<span class="c1">; These options affect how matching lines are printed. The</span>
+<span class="c1">; defaults are ideal for piping into other programs.</span>
+<span class="c1">;</span>
<span class="c1">; --color highlight matches with color</span>
<span class="c1">; --no-color don't highlight matches (the default)</span>
-<span class="c1">; -U N, --context N show N lines of context (default 0)</span>
+<span class="c1">; -u N, --context N show N lines of context (default 0)</span>
</pre></div>