Changeset 39056 in project


Ignore:
Timestamp:
10/03/20 04:55:21 (4 weeks ago)
Author:
Jim Ursetto
Message:

wiki/chicken-doc: Update for 0.7.0, always/auto/never colorization

Location:
wiki/eggref
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/chicken-doc

    r37453 r39056  
    183183currently be configured beyond enabling and disabling colorization.
    184184
    185 To enable:
    186 
    187  export CHICKEN_DOC_COLORS=auto
    188 
    189 Colorization will then be enabled when output is directed to a
     185To enable automatic colorization:
     186
     187 export CHICKEN_DOC_COLORS=auto      # auto | always | never
     188
     189{{auto}} enables colorization when output is directed to a
    190190terminal and your TERM variable is set (to anything other than
    191 "dumb").  Using {{chicken-doc}}'s pager facility counts as
     191{{dumb}}).  Using {{chicken-doc}}'s pager facility counts as
    192192a terminal; we assume your pager supports ANSI escape sequences,
    193193as in {{less -R}}.
     194
     195{{always}} will colorize unconditionally, and {{never}} turns it off.
     196
     197If unset or none of these options, it is disabled.
    194198
    195199==== Examples
     
    240244 [...]
    241245
    242 Show `with-...-port` identifiers:
     246Show {{with-...-port}} identifiers:
    243247
    244248 $ chicken-doc -m with-.+-port
     
    573577==== Version history
    574578
     579; 0.7.0 : Add always-on and never-on colorization options (wasamasa)
     580; 0.6.1 : Fix check for whether we are running inside modern Emacs (wasamasa)
    575581; 0.6.0 : Repository version 4. Store identifier cache keys as strings not symbols, to avoid read/write invariance issues with read-syntax.
    576582; 0.5.0 : Port to Chicken 5. Use 0.6.0 instead to avoid a bug in Chicken 5.0.0.
  • wiki/eggref/5/chicken-doc

    r37453 r39056  
    183183currently be configured beyond enabling and disabling colorization.
    184184
    185 To enable:
    186 
    187  export CHICKEN_DOC_COLORS=auto
    188 
    189 Colorization will then be enabled when output is directed to a
     185To enable automatic colorization:
     186
     187 export CHICKEN_DOC_COLORS=auto      # auto | always | never
     188
     189{{auto}} enables colorization when output is directed to a
    190190terminal and your TERM variable is set (to anything other than
    191 "dumb").  Using {{chicken-doc}}'s pager facility counts as
     191{{dumb}}).  Using {{chicken-doc}}'s pager facility counts as
    192192a terminal; we assume your pager supports ANSI escape sequences,
    193193as in {{less -R}}.
     194
     195{{always}} will colorize unconditionally, and {{never}} turns it off.
     196
     197If unset or none of these options, it is disabled.
    194198
    195199==== Examples
     
    240244 [...]
    241245
    242 Show `with-...-port` identifiers:
     246Show {{with-...-port}} identifiers:
    243247
    244248 $ chicken-doc -m with-.+-port
     
    573577==== Version history
    574578
     579; 0.7.0 : Add always-on and never-on colorization options (wasamasa)
     580; 0.6.1 : Fix check for whether we are running inside modern Emacs (wasamasa)
    575581; 0.6.0 : Repository version 4. Store identifier cache keys as strings not symbols, to avoid read/write invariance issues with read-syntax.
    576582; 0.5.0 : Port to Chicken 5. Use 0.6.0 instead to avoid a bug in Chicken 5.0.0.
Note: See TracChangeset for help on using the changeset viewer.