Changeset 40554 in project


Ignore:
Timestamp:
09/14/21 01:01:56 (9 days ago)
Author:
Jim Ursetto
Message:

wiki: update args for 1.6.2

Location:
wiki/eggref
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/args

    r39572 r40554  
    1 == Outdated egg!
    2 
    3 This is an egg for CHICKEN 4, the unsupported old release.  You're almost certainly looking for [[/eggref/5/args|the CHICKEN 5 version of this egg]], if it exists.
    4 
    5 If it does not exist, there may be equivalent functionality provided by another egg; have a look at the [[https://wiki.call-cc.org/chicken-projects/egg-index-5.html|egg index]]. Otherwise, please consider porting this egg to the current version of CHICKEN.
    6 
    71[[tags:eggs]]
    82
     
    128122based on the length of the longest option, but you can set its width manually.
    129123
     124The formatter maintains at least 2 spaces between the option keys and
     125the option docstrings. If there is not enough space, the docstring
     126will start on the next line. The 2 spaces of padding are included in
     127{{args:width}}.  The indent does not get counted in {{args:width}}. So
     128the docstrings always begin at column {{args:indent + args:width}}.
     129
    130130<parameter>(args:separator [default: ", "])</parameter>
    131131
     
    134134<parameter>(args:indent [default: 1])</parameter>
    135135
    136 Number of spaces to indent the options from the left.
     136Number of spaces to indent the options from the left. This is not considered
     137to be part of `args:width`.
    137138
    138139=== Operands and unrecognized options (advanced)
     
    166167          (print "elephant: arg is " arg))
    167168        (args:make-option (f file)      (required: "NAME")   "parse file NAME")
     169        (args:make-option (l really-long-option-name) (required: "NAME")
     170                          "very long option NAME to show wrapping")
    168171        (args:make-option (v V version) #:none     "Display version"
    169172          (print "args-example $Revision: 1.3 $")
     
    204207  -e, --elephant=ARG       flatten the argument
    205208  -f, --file=NAME          parse file NAME
     209  -l, --really-long-option-name=NAME
     210                           very long option NAME to show wrapping
    206211  -v, -V, --version        Display version
    207212      --abc                Recite the alphabet
     
    218223 
    219224      -c --cookie                        give me cookie
    220       -d [LEVEL]                         debug level [default: 1]
     225      -d --debug[=LEVEL]                 debug level [default: 1]
    221226      -e --elephant=ARG                  flatten the argument
    222227      -f --file=NAME                     parse file NAME
     228      -l --really-long-option-name=NAME  really long option NAME to show wrapping
    223229      -v -V --version                    Display version
    224230         --abc                           Recite the alphabet
    225231      -h --help                          Display this text
    226232
    227 Additional examples can be found in [[http://bugs.call-cc.org/browser/release/4/args/trunk/args-examples.scm|args-examples.scm]].
    228 
     233Additional examples can be found in [[http://bugs.call-cc.org/browser/release/4/args/trunk/args-examples.scm|args-examples.scm]] in the egg.
    229234
    230235== Bugs
     
    236241=== Author
    237242
    238 [[http://3e8.org/zb|Jim Ursetto]]
     243[[https://github.com/ursetto|Jim Ursetto]]
     244
     245=== Repository
     246
     247This egg is hosted on the [[https://anonymous@code.call-cc.org/svn/chicken-eggs/release/4/args|CHICKEN Subversion repository]].
     248
     249If you want to check out the source code repository of this egg and
     250you are not familiar with Subversion, see [[/egg-svn-checkout|this page]].
    239251
    240252=== Version history
    241253
     254; 1.6.2 : Ensure option wrapping works properly when indent != 1
     255; 1.6.1 : Wrap long options at {{args:width}} instead of truncating (@tkurtbond)
     256; 1.6.0 : Ported to CHICKEN 5 [Kooda]
    242257; 1.5.1 : Bugfix for 1.5.0 -- ensure option body sees transformed {{#t}} arg value
    243258; 1.5.0 : {{#:optional}} args return a {{#t}} instead of {{#f}} value (suggested by Matt Gushee and Peter Bex)
     
    257272=== License
    258273
    259  Copyright (c) 2005-2013 Jim Ursetto.  All rights reserved.
     274 Copyright (c) 2005-2021 Jim Ursetto.  All rights reserved.
    260275 
    261276 Redistribution and use in source and binary forms, with or without
  • wiki/eggref/5/args

    r39962 r40554  
    122122based on the length of the longest option, but you can set its width manually.
    123123
     124The formatter maintains at least 2 spaces between the option keys and
     125the option docstrings. If there is not enough space, the docstring
     126will start on the next line. The 2 spaces of padding are included in
     127{{args:width}}.  The indent does not get counted in {{args:width}}. So
     128the docstrings always begin at column {{args:indent + args:width}}.
     129
    124130<parameter>(args:separator [default: ", "])</parameter>
    125131
     
    128134<parameter>(args:indent [default: 1])</parameter>
    129135
    130 Number of spaces to indent the options from the left.
     136Number of spaces to indent the options from the left. This is not considered
     137to be part of `args:width`.
    131138
    132139=== Operands and unrecognized options (advanced)
     
    162169          (print "elephant: arg is " arg))
    163170        (args:make-option (f file)      (required: "NAME")   "parse file NAME")
     171        (args:make-option (l really-long-option-name) (required: "NAME")
     172                          "very long option NAME to show wrapping")
    164173        (args:make-option (v V version) #:none     "Display version"
    165174          (print "args-example $Revision: 1.3 $")
     
    200209  -e, --elephant=ARG       flatten the argument
    201210  -f, --file=NAME          parse file NAME
     211  -l, --really-long-option-name=NAME
     212                           very long option NAME to show wrapping
    202213  -v, -V, --version        Display version
    203214      --abc                Recite the alphabet
     
    214225 
    215226      -c --cookie                        give me cookie
    216       -d [LEVEL]                         debug level [default: 1]
     227      -d --debug[=LEVEL]                 debug level [default: 1]
    217228      -e --elephant=ARG                  flatten the argument
    218229      -f --file=NAME                     parse file NAME
     230      -l --really-long-option-name=NAME  really long option NAME to show wrapping
    219231      -v -V --version                    Display version
    220232         --abc                           Recite the alphabet
    221233      -h --help                          Display this text
    222234
    223 Additional examples can be found in [[http://bugs.call-cc.org/browser/release/5/args/trunk/args-examples.scm|args-examples.scm]].
    224 
     235Additional examples can be found in [[http://bugs.call-cc.org/browser/release/5/args/trunk/args-examples.scm|args-examples.scm]] in the egg.
    225236
    226237== Bugs
     
    232243=== Author
    233244
    234 [[http://3e8.org/zb|Jim Ursetto]]
     245[[https://github.com/ursetto|Jim Ursetto]]
    235246
    236247=== Repository
    237248
    238 This egg is hosted on the CHICKEN Subversion repository:
    239 
    240 [[https://anonymous@code.call-cc.org/svn/chicken-eggs/release/5/args|https://anonymous@code.call-cc.org/svn/chicken-eggs/release/5/args]]
     249This egg is hosted on the [[https://anonymous@code.call-cc.org/svn/chicken-eggs/release/5/args|CHICKEN Subversion repository]].
    241250
    242251If you want to check out the source code repository of this egg and
    243252you are not familiar with Subversion, see [[/egg-svn-checkout|this page]].
    244253
    245 
    246254=== Version history
    247255
     256; 1.6.2 : Ensure option wrapping works properly when indent != 1
     257; 1.6.1 : Wrap long options at {{args:width}} instead of truncating (@tkurtbond)
    248258; 1.6.0 : Ported to CHICKEN 5 [Kooda]
    249259; 1.5.1 : Bugfix for 1.5.0 -- ensure option body sees transformed {{#t}} arg value
     
    264274=== License
    265275
    266  Copyright (c) 2005-2013 Jim Ursetto.  All rights reserved.
     276 Copyright (c) 2005-2021 Jim Ursetto.  All rights reserved.
    267277 
    268278 Redistribution and use in source and binary forms, with or without
Note: See TracChangeset for help on using the changeset viewer.