Home

The Clon Reference Manual - LRDE

1. 0 80 name fa gisele eee ees 81 negated call 81 negated pack 81 negated pack char 81 NOVATOS Scala das 82 122 Generic Function open frame 82 Generic Function option 0 82 Generic Function option sticky distance 82 Generic Function output stream 83 Generic Function parent 0 83 Generic Function path type 2 83 Generic Function postfix ssssss 83 Generic Function potential pack 83 Generic Function potential pack p 84 Generic Function print help spec 84 Generic Function retrieve from environment 84 Generic Function retrieve from long call 85 Generic Function retrieve from negated call AAA A O AE 85 Generic Function retrieve from short call 85 Generic Function right padding 86 Generic Function search path 86 Generic Function sface tree ssss 86 Generic Function short call 86 Generic Function short name sss 86 Generic Function short pack 86 Generic Function short pack char 87 Generic Function short syntax help spec prefix Toc 87 Generic Function Sibling ooooooocooocmo o 87 Generic Function stream ioctl output handle rH 87 Generic Function stringifY
2. 82 setf traversedp 89 setf yes values 91 argument 005 70 argument name 70 argument required p 70 argument style 70 argument styles 70 background 66 71 bbinkjs l2 cele a et ed 71 bottom padding 71 do A eee eis 71 check name clash 72 clon options group 72 close frame esses 73 cmdline options 73 Col mm s52lSlee ie e eal edd ve 73 COMMON vac wis ec trees 73 concealedp ssssss 73 CONTONGS cita di 74 CONV Deia ca ay heute 74 copy instance 74 crossed out p coco 75 default value 75 description 75 UM Mee aout 75 A n ep nA 75 CNV AV AR oia wea cle Mi erences oat 75 error handler 76 error string 76 fallback value 76 foreground 0 76 A RIXA 76 frames live nubi 76 get bottom padding 77 AAA iuga rpn egies 77 help spisi rison e ek 77 help spec will print 78 Hidden eri la 78 pha ght rei ER 78 highlightp cesses 78 intensJty i ace x I ES 78 inVersep indi ad 79 ITALIA 79 ICO Ah u ae ena pe EUR TES 79 item separator 79 Items A AS 79 o 79 left padding 79 line widthz c since achat 80 Long Hames canica yates 80 make face tree 80 Mapoptions
3. ccc eee eee 51 highlight property instance escape sequence ETA AA E Rotes Hi P 57 The Clon Reference Manual highlight property instance name 58 highlight property instance p 58 highlight property instance value 58 iehlighbD A t riciety D Gnas Cp MAN KRAD 78 home directOry iic ilk MIRI Libre set 58 i readerziie eex ip ee S e ER PEE OPE EP 58 in readtabi6 1 62 9b ELI D ee bet 51 intensity ioco IESBMERI PEORES ERIS 78 INVETSEP ibis n sc daeae bes 4 bees ta ewes 79 o ms hie licel icut 79 itemnei o lf dc DURER DINERS 79 iten separator ici 79 itens as e a 79 left padding coccion ains 79 80 E icc RE 80 Tist to String ii o 58 Long name iaa jes 80 M MAC Ponts ars qd 58 Macro 4defgroup esse 50 Macro accumulate sees eee 50 Macro declare valid superclass 50 Macro defabstract ccc cee eee eee nee 50 Macro def groupiero tas aod eee ena 42 Macro defindent 00 cee eee eee eens 50 Macro defoption ne REM er 51 Macro defsynopsis 00 eee eee eee eee 42 Macro do cmdline options sess 42 Macro do options 0 eene 51 Macros dump auc Deo RID Oe 42 Macro ECO ni os 51 Macro endpushi et EIE APR T 51 Macro highlight property ecase 51 Macro in readtable 0 cee eee eee eee 51 MA cro map frames s yii E TIRE nc 51 Macro maybe pop argument
4. convert page 74 copy cmdline option page 55 function copy frame page 55 function copy highlight frame page 55 function copy highlight property instance page 55 function copy instance page 74 generic function copy instance page 75 method crossed out p page 75 generic function crossed out p page 75 method current frame page 55 function current left margin page 55 function current right margin page 55 function current sface page 55 function declare valid superclass page 50 macro defabstract page 50 macro default value page 75 generic function default value page 75 method defindent page 50 macro defoption page 51 macro description page 75 generic function description page 75 method directory pathname p page 55 function do options page 51 macro econd page 51 macro endpush page 51 macro enum page 75 generic function enum page 75 method enum page 102 class enum base page 102 class env val page 75 generic function method generic function method method env val page 75 env var page 75 env var page 75 PA AA N env var page 75 Chapter 5 Packages 31 e environment convert page 55 function e environment error page 92 condition e environmental option error page 93 condition e error handler page 76 generic function e error handler page 76 method
5. sess 51 Macro maybe push sssessssseeeeeeeee 52 Macro multiple value getopt cmdline 43 Macro replace in keys s sssssss 52 Macro restartable invalid negated syntax error vulrdba senta tes pies uo tres ts Luisa 52 Macro restartable spurious cmdline argument GrErOr l l sexi E 52 Macro with context eee eee eee eee eee 43 Macro with context error handler 52 Macro with winsize eee eee eee eee 52 make cmdline option cece cece eee 58 make Cont xt 2 aseo a as RU PER 44 mnake enu m z aclara Bone ade 45 nake face tree se dia RE 80 Appendix A Indexes E AAA O 58 Make PTU a e 45 make highlight frame 0 eee 59 make highlight property instance 59 make internal enum 0 cece eee eee 59 make internal flag cece eee eee ee 59 make internal lispobj cee eee 59 make internal path 0 cece 60 make internal stropt lesse 60 make internal switch eee eee 61 make internal text 0 cece eee eee 61 make internal xswitch 0 cece eee 61 make Lispobjs sti 02 52 sheehiaes R34 A44 L REIR 45 Make path ii AAA A 46 make raw face tree ieee eee 61 make raw sfaCe vii elie ee eh a E 62 make sheest daros OS Larne eV ome dees eh aS 62 maks Str Opt ciated oka AT ose 46 maks suiteko oeny nec r E te Meet 47 Make SyNOPS
6. esses 117 A 3Gonceplsciconevtebbbereepeis pue EE EE wae oie ale rete deest Mah ps 118 ACD HUNG OS a E Sd ai 119 A9 Variables li A ds 126 AM Data types A AS IRR aaa 128 Copying Copying Permission to use copy modify and distribute this software for any purpose with or without fee is hereby granted provided that the above copyright notice and this permission notice appear in all copies THIS SOFTWARE IS PROVIDED AS IS AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL DIRECT INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHAT SOEVER RESULTING FROM LOSS OF USE DATA OR PROFITS WHETHER IN AN ACTION OF CONTRACT NEGLIGENCE OR OTHER TORTIOUS AC TION ARISING OUT OF OR IN CONNECTION WITH THE USE OR PER FORMANCE OF THIS SOFTWARE Chapter 1 Introduction 3 1 Introduction Clon is a library for managing command line options in standalone Common Lisp applications It provides a unified option syntax with both short and long names automatic completion of partial names and automatic retrieval conversion of option arguments from the command line associated environment variables fallback or default values Clon comes with a set of extensible option types switches paths strings etc Clon also provides automatic generation and formatting of help strings with support for highlightin
7. tenen E pipe initi i 88 Method subface cece eee eee eee ro 88 Method subfaces 0 eee eee eee nee 89 Method synopsis eese 89 Method theme eee eee cece eee eens 89 Method top padding 0000 89 Method traversedp 0 0c eee eee 89 Method typespec ee eee eee 90 Method underline 0 eee eee ee eee 90 Method untraverse eee eee eee 90 Method value cc eee eee eee eee teens 90 Method visiblep ee eee eee 91 Method yes values 0 000000085 91 multiple value getopt cmdline 43 124 MAMA AN oia wee over ak n wes 81 negated CAL Dir cc ln trend tate atar nest 81 negated pack lel lug il la eb 81 negated pack char 0 cece eens 81 82 nickname package 0c ee EE eee eee 48 no values u se EEA A ee Ode set ge wes 82 O open frame ii 055590 niet bees hale esi M 82 open line ico v 4f pep Re DX DRESS 62 open next line 69 in WR id 62 Open Sface iii ii rad 62 Options carole 2yhs See UE Ee ee etn 82 option abbreviation distance 62 OptronzcaLkl p csniisenjem ilnets la Deui 62 option sticky distance sss 82 83 output stream iils gu ele tr puc px epe 83 P parent 22 2s5 689 ia o toari aaa oe 83 parent generatiOn eese 63 Path type tec gies ds 83 pathname com
8. oooooocmomm 88 Generic Function subface o ooccccccccccccco oo 88 Generic Function subfaces 0000 89 Generic Function synopsis 89 Generic Function theme 0 0 ee eee eee 89 Generic Function top padding 89 Generic Function traversedp 89 Generic Function typespec 0 90 Generic Function underline 90 Generic Function untraverse 90 Generic Function value 0 cece eee eee 90 Generic Function visiblep 90 Generic Function yes values 91 get bottom padding 0 cece cece eee ee 77 get top padding eee cece eee eee 57 PSLENV ai a rase dubius 57 O ss ac der elawtisds callie onde ved scales wate 44 getopt cmdline 3 6 tac eer da 44 H header oe ERRRDUN eh ee Ee RHET 77 h lp cib LIED PRMW bee th oa a ee baw at 44 help spee o hse0elDie T iad he eee edad 77 78 help spec items will print 57 help spec will print sessssss 78 A ce OR ey a cle pM was SaaS Es 78 Highlight cask sch rr Ane eda 78 highlight frame highlight property instances A E woe T E 57 highlight frame left margin 57 highlight frame p 0 cece eee eee eee 57 highlight frame right margin 57 highlight frame sface seen 57 highlight property ecase
9. 2 Systems The main system appears first followed by any subsystem dependency 2 1 net didierverna clon Long Name The Command Line Options Nuker Author Didier Verna Contact didier didierverna net Home Page http www lrde epita fr didier software lisp clon php Source Control https github com didierverna clon License BSD Description Command line options management for standalone Common Lisp applications Long Description Clon is a library for command line options management It is intended to ease the creation of standalone Common Lisp applications by providing a powerful and uniform command line options interface The most important features of Clon are the following From the application programmer s point of view centralized command line op tions specification and management including automatic generation of help strings conversion from command line defaults fallbacks environment variables to application level option values global or on demand option retrieval and extensi bility the programmer can define his own option types From the application user s point of view uniform command line option syntax across all Clon applications customization of the help strings layout with optional 1506429 coloring on terminals that support it automatic completion of abbreviated option names and short long pack syntax Dependencies e net didierverna clon setup page 7 system e net didierverna clon
10. If MAKE CURRENT make the new context current Package net didierverna clon page 27 Source context page 23 Lisp file Chapter 6 Definitions 45 make enum amp rest KEYS amp key SHORT NAME LONG NAME Function DESCRIPTION ARGUMENT NAME ARGUMENT TYPE ENUM ENV VAR FALLBACK VALUE DEFAULT VALUE HIDDEN Make a new enum option SHORT NAME is the option s short name without the dash It defaults to nil LONG NAME is the option s long name without the double dash It defaults to nil DESCRIPTION is the option s description appearing in help strings It defaults to nil ARGUMENT NAME is the option s argument name appearing in help strings ARGUMENT TYPE is one of required mandatory or optional required and mandatory are synonyms It defaults to optional ENUM is the set of possible values ENV VAR is the option s associated environment variable It defaults to nil FALLBACK VALUE is the option s fallback value for missing optional arguments if any DEFAULT VALUE is the option s default value if any When HIDDEN the option doesn t appear in help strings Package net didierverna clon page 27 Source enum page 17 Lisp file make flag amp rest KEYS amp key SHORT NAME LONG NAME Function DESCRIPTION ENV VAR HIDDEN Make a new flag SHORT NAME is the option s short name without the dash It defaults to nil LONG NAME is the option s long name without the double dash
11. e error string page 76 generic function e error string page 76 method e setf error string page 76 method e setf error string page 76 generic function e exit abnormally page 56 function e face page 102 class e face highlight property set p page 56 function e face highlight property value page 56 function e fallback value page 76 generic function e fallback value page 76 method e find sface page 56 function e flag page 106 class e flush sheet page 56 function e foreground page 76 generic function e foreground page 76 method e frame page 98 structure e frame left margin page 56 function e setf frame left margin page 56 function e frame p page 56 function e frame right margin page 56 function e setf frame right margin page 56 function e frame sface page 56 function e setf frame sface page 56 function e framedp page 76 generic function e framedp page 76 method e frames page 76 generic function e frames page 76 method e setf frames page 76 method e setf frames page 76 generic function e free winsize page 57 function e get bottom padding page 77 generic function e get bottom padding page 77 method e get bottom padding page 77 method e get top padding page 57 function e getenv page 57 function e group page 106 class
12. e restartable cmdline convert page 66 function Chapter 4 Files 19 e restartable invalid negated syntax error page 52 macro e restartable spurious cmdline argument error page 52 macro e retrieve from long call page 85 generic function e retrieve from long call page 85 method e retrieve from long call page 85 method e retrieve from negated call page 85 generic function e retrieve from negated call page 85 method e retrieve from negated call page 85 method e retrieve from negated call page 85 method e retrieve from short call page 85 generic function e retrieve from short call page 85 method e retrieve from short call page 85 method e spurious cmdline argument page 96 condition 4 1 26 core src retrieval environ lisp Parent retrieval page 10 module Location core src retrieval environ lisp Internal Definitions e environment convert page 55 function e environment error page 92 condition e environmental option error page 93 condition e invalid environment value page 94 condition e read env val page 65 function e restartable environment convert page 67 function e retrieve from environment page 84 generic function e retrieve from environment page 84 method e retrieve from environment page 84 method e retrieve from environment page 84 method 4 1 27 core src synopsis lisp Dependency group
13. short name Slot The option s short name Chapter 6 Definitions 109 Type or null string Initargs short name Readers short namel page 86 generic function long name Slot The option s long name Type or null string Initargs long name Readers long namel page 80 generic function description Slot The option s description Type or null string Initargs description Readers description page 75 generic function env var Slot The option s associated environment variable Type or null string Initargs env var Readers env var page 75 generic function Direct Default Initargs Initarg Value internal nil path Class The PATH class This class implements options whose values are colon separated lists of pathnames Package net didierverna clon page 27 Source path page 16 Lisp file Direct superclasses valued option page 114 class Direct methods e convert page 74 method e check page 71 method e stringify page 88 method e path typel page 83 method Direct slots argument name Slot Initform path path type Slot The path type Initargs type Readers path typel page 83 generic function 110 The Clon Reference Manual sface Class The SFACE class An SFace is the association of a face and its raw sibling The sibling is used to create subfaces which would be missing from the original user defined one Package net didierverna clon
14. It defaults to nil DESCRIPTION is the option s description appearing in help strings It defaults to nil ENV VAR is the flag s associated environment variable It defaults to nil When HIDDEN the option doesn t appear in help strings Package net didierverna clon page 27 Source flag page 14 Lisp file make group amp rest KEYS amp key HEADER ITEM HIDDEN Function Make a new group Package net didierverna clon page 27 Source group page 18 Lisp file make lispobj amp rest KEYS amp key SHORT NAME LONG NAME Function DESCRIPTION ARGUMENT NAME ARGUMENT TYPE ENV VAR TYPESPEC FALLBACK VALUE DEFAULT VALUE HIDDEN Make a new lispobj option SHORT NAME is the option s short name without the dash It defaults to nil LONG NAME is the option s long name without the double dash 46 The Clon Reference Manual It defaults to nil DESCRIPTION is the option s description appearing in help strings It defaults to nil ARGUMENT NAME is the option s argument name appearing in help strings ARGUMENT TYPE is one of required mandatory or optional required and mandatory are synonyms It defaults to optional ENV VAR is the option s associated environment variable It defaults to nil TYPESPEC is a type specifier the option s value should satisfy FALLBACK VALUE is the option s fallback value for missing optional arguments if any DEFAULT VALUE is the option s defau
15. header Slot The group s header Initargs header Readers header page 77 generic function item Class The ITEM class This class is the base class for all synopsis items Package net didierverna clon page 27 Source item page 12 Lisp file Direct superclasses standard object Direct subclasses e text page 114 class Chapter 6 Definitions e option page 108 class e container page 99 class Direct methods e mapoptions page 81 method e help spec page 78 method e untraverse page 90 method e hiddenp page 78 method e traversedp e traversedp page 89 method Direct slots traversedp The item s traversal state Readers traversedp page 89 generic function Writers setf traversedp page 89 generic function hiddenp Whether the item is hidden in help strings Initargs hidden Readers hiddenp page 78 generic function lispobj The LISPOBJ class This class implements read from string options Package net didierverna clon page 27 Source lispobj page 16 Lisp file Direct superclasses valued option page 114 class Direct methods convert page 74 method check page 71 method e stringify page 88 method e typespec page 90 method Direct slots argument name Initform obj typespec A type specifier the option s value should satisfy Initargs typespec Initform t Readers typespec page 9
16. page 18 Lisp file Parent src page 9 module Location core src synopsis lisp Exported Definitions e synopsis page 41 special variable e defsynopsis page 42 macro e make synopsis page 47 function Internal Definitions e clon options group page 72 method e do options page 51 macro e help spec page 77 method e mapoptions page 80 generic function 20 The Clon Reference Manual mapoptions page 81 method mapoptions page 81 method mapoptions page 81 method mapoptions page 81 method negated pack page 81 method postfix page 83 method potential pack page 84 method potential pack p page 84 generic function potential pack p page 84 method short pack page 87 method synopsis page 113 class 4 1 28 core src output face lisp Parent output page 10 module Location core src output face lisp Internal Definitions highlight properties page 50 special variable add subface page 52 function attach face tree page 53 function background page 71 method blink page 71 method bottom padding page 71 method concealedp page 74 method crossed out p page 75 method face page 102 class face highlight property set p page 56 function face highlight property value page 56 function foreground page 76 method framedp page 76 method intensity page 78 method inversep page 79 method ital
17. page 27 Source Users didier cache common lisp sbcl 1 2 13 35 6102b24 macosx x64 Users didier 6 2 2 Special variables executablep Special Variable Whether the current Lisp image is a standalone executable dumped by Clon This information is needed in some implementations that treat their command line differently in dumped images Package net didierverna clon page 27 Source util page 12 Lisp file 50 The Clon Reference Manual highlight properties The highlight face properties Package net didierverna clon page 27 Source face page 20 Lisp file item names The list of defined item names Package net didierverna clon page 27 Source valued page 14 Lisp file readtable The Clon readtable Package net didierverna clon page 27 Source neta page 11 Lisp file 6 2 3 Macros Special Variable Special Variable Special Variable Ydefgroup INTERNALP amp rest KEYS amp key HEADER HIDDEN amp body Macro FORMS Define a new group Package net didierverna clon page 27 Source group page 18 Lisp file accumulate INITIAL VALUE amp body BODY amp aux PLACE INITIAL PLACE Macro Accumulate BODY forms in a list beginning with INITIAL VALUE INITIAL VALUE is not evaluated BODY forms are accumulated only when their value is non nil If nothing to accumulate then return nil instead of the list of INITIAL VALUE Package net didierverna clon page 27
18. 0 eee eee ee 80 Method mapoptions 000008 81 Method name circa Sete p xa ees Med 81 Method negated call sse 81 Method negated pack 0 0 e cece ee 81 Method negated pack char esses 82 Method no values esses 82 Method open frame ssseess esses 82 Method option 0 cece eee eee 82 Method option sticky distance 83 Method output stream s esse sss se 83 Method parent e lliex ce 9 y a 83 Method path type 2 22 eee 83 Method postfiz cil nee oP eee eh 83 Method potential pack 0 0 84 Method potential pack p 84 Method print help spec 00 84 Method retrieve from environment 84 Method retrieve from long call 85 Method retrieve from negated call 85 Method retrieve from short call 85 Method right padding sse 86 Method search path 0 000005 86 Method sface tree 2 eee eee eee eee 86 Method short call 1 eee ee eee eee 86 Method short name cece eee eee eee 86 Method short pack 002s eee 87 Method short pack char ssssss 8T Method short syntax help spec prefix 8T Method sibling sse 87 Method stream ioctl output handle 88 Method stringify
19. 96 97 item separatore cis vue eee Se Seen ee ah 104 bug o PED 100 left margini o 0flebxa e dae ee Debe ePi ua 98 left padding 0 ccc eee eee eee eee 103 DINO WLOCH A o 101 110 Long naMme pid deri diep Aan tle 344b rates 109 NAMC reis EMA Rigg iaa 97 99 103 negated packs i ios gs leet bats bs 114 NO VATUES hiss c ea al ee A 113 O offset of winsize ws col eee 49 offset of winsize WS rOW eese eee 49 offset of winsize ws xpixel ss 49 offset of winsize ws ypixel ss 49 options tnry tei pie PAs ees oe 96 97 OUtput stream on ia A tee 110 Parente haar toes o et EOT EE De Pene 106 path typetSisosswe usse supe hanes a qti e 109 postflXxcscx 45 ge abuse ue odes bits drm 113 potential pack cts er Tree 114 PROPMAME 2 a3 Vries stad eee ima a ewe alee a ates 101 R TOMA iio Wek DOSE lee ees te 101 right mWargin Jc kn eet a eee bie 98 Sight padding jcc was ww cs 104 Appendix A Indexes S search path A a 101 A syed a ate ets were nee eats vg 98 Sface cLtreeu o a hie re us hoe td 111 short name s iph oue heed he ae ei 108 Short padcks cs pRSIEIMARUERCPR PEIPER 114 SD ado bene ERAT eunt 110 Size of winsiZze i exiit lbEibk diesen 49 Slot argument eese 93 94 96 Slot argument name 102 107 109 111 115 Slot argument required p sss 115 Slot argument style cesses 113 Slot argument styles ss
20. Source util page 12 Lisp file declare valid superclass CLASS SUPERCLASS Validate SUPERCLASS classes for CLASS classes Package net didierverna clon page 27 Source util page 12 Lisp file defabstract CLASS SUPER CLASSES SLOTS amp rest OPTIONS Like DEFCLASS but define an abstract class Package net didierverna clon page 27 Source util page 12 Lisp file defindent SYMBOL INDENT Set SYMBOL Ss indentation to INDENT in X Emacs SYMBOL and INDENT need not be quoted See CLINDENT for more information Package net didierverna clon page 27 Source neta page 11 Lisp file Macro Macro Macro Chapter 6 Definitions defoption CLASS SUPERCLASSES SLOTS amp rest OPTIONS Create a new option CLASS and register it with Clon Package net didierverna clon page 27 Source valued page 14 Lisp file do options OPT THERE amp body BODY Execute BODY with OPT bound to every option in THERE Package net didierverna clon page 27 Source synopsis page 19 Lisp file econd amp body CLAUSES Like COND but signal an error if no clause evaluates to t Package net didierverna clon page 27 Source util page 12 Lisp file endpush OBJECT PLACE Like push but at the end Package net didierverna clon page 27 Source util page 12 Lisp file highlight property ecase PROPERTY VALUE amp body CLAUSES Create an ECASE form to extract PROPERTY s VALUE escape sequence ol M
21. cee eee eee teens 74 Method convert ssseeeeeeee eee 74 Method copy instance 0 00005 75 Method crossed out p 00 02s ee eee 75 Method default value ss eee eee ee 75 Method description 0000 75 Method enum eee e eee ences 75 Method env vaL lp ri 75 Method env var eee eee eee ee eens 75 Method error handler esse eee 76 Method error string eese 76 Method fallback value esses 76 Method foreground sse 76 Method LLAMADA Ake 76 123 Method frames 0 eee eee eee eens 76 Method get bottom padding 77 Method header 0 eee cece eee ee 77 Method help spec 0000000 77 78 Method help spec will print 78 Method hiddenp 000 e eee eee ee 78 Method highlight 0 eee e eee 78 Method highlightp sse 78 Method intensity sees esses 78 Method inversep isis ibid 79 Method italicp 4 99 p pr Lb bp SEV 79 Method item wl E py Ibl 4px IR 79 Method item separator ooocccccccocccocccoo 79 Method Lt MS cui nas reme taie 79 Method JIM ta tain ease By WIR DA MUTO 79 Method left padding sss 80 Method line vidth sls sees 80 Method long name see 80 Method make face tree
22. e header page 77 generic function e header page 77 method 32 The Clon Reference Manual help spec page 77 generic function help spec page 77 method help spec page 77 help spec page 77 method help spec page 77 method help spec page 77 method help spec page 77 method help spec page 78 method help spec items will print page 57 function help spec will print page 78 generic function help spec will print page 78 method help spec will print page 78 method help spec will print page 78 method hiddenp page 78 generic function hiddenp page 78 method highlight page 78 generic function highlight page 78 method highlight frame page 98 structure highlight frame highlight property instances page 57 function setf highlight frame highlight property instances page 57 func tion highlight frame left margin page 57 function setf highlight frame left margin page 57 function highlight frame p page 57 function highlight frame right margin page 57 function setf highlight frame right margin page 57 function highlight frame sface page 57 function setf highlight frame sface page 57 function highlight property ecase page 51 macro highlight property instance page 99 structure highlight property instance escape sequence page 57 function highlight property instance name page 58 function
23. page 27 Source Users didier cache common lisp sbcl 1 2 13 35 6102b24 macosx x64 Users didier 70 The Clon Reference Manual winsize ws ypixel STRUCT Function setf winsize ws ypixel VAR 34 STRUCT Function Package net didierverna clon page 27 Source Users didier cache common lisp sbcl 1 2 13 35 6102b24 macosx x64 Users didier 6 2 5 Generic functions argument CONDITION Generic Function Package net didierverna clon page 27 Methods argument CONDITION unknown cmdline option error Method argument CONDITION spurious cmdline argument Method argument CONDITION invalid argument Method argument name OBJECT Generic Function Package net didierverna clon page 27 Methods argument name VALUED OPTION valued option Method The option s argument display name Source valued page 14 Lisp file argument required p OBJECT Generic Function Package net didierverna clon page 27 Methods argument required p VALUED OPTION valued option Method Whether the option s argument is required Source valued page 14 Lisp file argument style OBJECT Generic Function Package net didierverna clon page 27 Methods argument style SWITCH BASE switch base Method The selected argument style Source switch base page 15 Lisp file argument styles OBJECT Generic Function setf argument styles NEW VALUE OBJECT Generic Function Package net didierverna clon page 27 Methods argument styles SWITCH BASE
24. page 39 Source setup page 25 Lisp file add subface FACE SUBFACE Function Add SUBFACE to FACE s subfaces and return it Package net didierverna clon page 27 Source face page 20 Lisp file Chapter 6 Definitions 53 allocate winsize Function Package net didierverna clon page 27 Source Users didier cache common lisp sbcl 1 2 13 35 6102b24 macosx x64 Users didier argument popable p CMDLINE Function Return true if the first CMDLINE item is an argument Package net didierverna clon page 27 Source cmdline page 18 Lisp file attach face tree FACE FACE TREE amp aux NEW TREE Function Create a copy of FACE TREE attach it to FACE and return it Apart from the parenting information the copied faces share slot values with the original ones Package net didierverna clon page 27 Source face page 20 Lisp file available right margin SHEET Function Return SHEET s available right margin This margin is the first non self margin specified by a frame All inner self frames can potentially write until the available right margin Package net didierverna clon page 27 Source sheet page 21 Lisp file beginning of string p BEGINNING STRING amp optional IGNORE CASE Function amp aux LENGTH Check that STRING starts with BEGINNING If IGNORE CASE well ignore case Package net didierverna clon page 27 Source util page 12 Lisp file clindent SYMBOL INDENT Function Set SYM
25. 113 rgument Styles E EA 112 B background AAA ee a ied beeen eee 105 bi1ink g i il ent elt aes Wee elas ee eres 105 bottom padding ponid eee eee eee 104 C clon options group ssseee eee 114 emdline options 262520 2 9 WD 20 pb gr 101 column vbarlsiBeg bene Pe dus 111 COMME NEM PET 94 95 concealed pinin g4 ee IUE REDE 105 CONFI PUTATLON chi ii rd he alae ee e pcd dee 42 Constant ttiocgwinsz t eee 49 Constant offset of winsize ws col 49 Constant offset of winsize ws row 49 Constant offset of winsize ws xpixel 49 Constant offset of winsize ws ypixel 49 Constant size of winsize suus 49 contents cami ERR EBIAMM 114 crogsed o t p cw li aia la 105 D defa lt value iniciada inicial e ndo Ge es va 116 description debi isa Sa 109 E ENUM dut cueste Fa irte EUER GER dicas 102 116 O A spp RV CHEER 92 109 error handler lee gv ESeies 101 error String ii sean ae vise rra 93 The Clon Reference Manual F fallback value ces ceed can eb dolida aed 115 foreground iii 105 framedpy 424324 hurries aa se ihe Meinl s 105 E es 111 header ee eae et Stes Sas Se Se ed eee Bae Ga Sa 106 Diderot aora aad v 107 Aida MPO 101 highlight property instances 99 Mg A id 111 I intensity A hat e ue DERI RE UR ees 104 inyersepsu sib e EDEN des 105 jtaliCp 14 Sees eke Te Ae lead DIS 105 itens Mesh eee PIRE pes 91 92
26. 70 method setf argument styles page 70 method setf argument styles page 70 generic function attach face tree page 53 function available right margin page 53 function background page 71 generic function background page 71 method beginning of string p page 53 function blink page 71 generic function blink page 71 method bottom padding page 71 generic function bottom padding page 71 method check page 71 generic function check page 71 method check page 71 method method check page 71 method check page 71 check page 72 method check page 72 method check name clash page 72 generic function check name clash page 72 method check name clash page 72 method Chapter 5 Packages 29 e check name clash page 72 method e check name clash page 72 method e check name clash page 72 method e check name clash page 72 method e clindent page 53 function e clon options group page 72 generic function e clon options group page 72 method e clon options group page 72 method e close framel page 73 generic function e close framel page 73 method e close framel page 73 method e close line page 53 function e close sface page 53 function e closest match page 54 function e cmdline convert page 54 function e cmdline error page 91 condition e cmdline junk error
27. 92 environmental option error s s 93 The Clon Reference Manual Lacuna ia a 102 SEL ii la Shee See tid is 106 framexs A A tether ates 98 BUOUP ind 106 highlight frame ooooooccocccccocncnncorr 98 highlight property instance 99 homne direCtory eee one cchu wey ee tren 93 I invalid argument 0 cece cece eee eee 93 invalid cmdline argument 94 invalid environment value 94 invalid negated equal syntax 94 invalid negated syntax sssss 94 invalid short equal syntax esses 95 inyalid value cawectbreebhersstuee a pestes 95 DG OM cuore A ADU RES A 106 M missing cmdline argument 95 N negatdble li 2 chive RIP TILES SELL II 108 net didierverna clon esses 5 27 net didierverna clon core eese T net didierverna clon setup 7 39 net didierverna clon setup termio 6 net didierverna clon termio 5 O mE 108 Option error side henach ya Ret ane eet he 95 P Package net didierverna clon 27 Package net didierverna clon setup 39 Parita cd e lada 109 AC a Were hs um nia 110 Ad e Aer 110 spurious cmdline argument 96 Appendix A Indexes Structure cndline option sssss 97 structure frame iC iLonsdbh e Caracal des 9
28. PEU ERA ERER i 43 COnfig FGe ia ria aa 44 CONCE a do e ei 74 COMU os 50e ahr cat ee eae Sour alee 74 copy cmdline option cesis rer ee 55 COpy frame o tro al ENS 55 copy highlight rame o o oooooooooommmmooo 55 copy highlight property instance 55 copy instahnce 1 2 ri tice cives 74 75 CLOS SEAT OU E ii nea een ties ene Eee he es 75 Curnent framey tee aa ties 55 current left margin cece eee eee 55 current right margin sess 55 c rrent sface uoscsuitekeveisprasi ben 55 D declare valid superclasS ooooccocccccccc 50 defabstractz eiue tee ek dudan ee tea Ue 50 default value iaa oe boda 75 GSE STOUP wha aie e ei dad 4 ra uel y dea wield se 42 det INES DI eur UN 50 defoption s pel PEDIR tz 51 defsynOpsis sis2 pe lilt 8 D EQIESIDETAR MP IE 42 deseri pt Ion ai rea aee ehe deed epe 75 directory pathname p lene 55 do cmdline options cee eee eee 42 CO OPtLOnS so ject eS DART SA aa 51 dump See a 42 E ECONA prisas eR Ro pe yess RR RE REPRE a ARES 51 endpush sehe tte eee eter ESAE eT EE 51 SAA i DELE bees Db epe 75 SOV AVAL O a a Dee 75 enV Va eer tenets ae Sale ent ended AS 75 environment convert eese 55 error handler tuu AR RE EUER 76 error String in ii BEE REY 76 ORANG cir man ihv daten Dep RARI RU PERS 44 exit abnormally srice sor ibas tee oe 56 120 F face highlight property set p 56 fac
29. SHEET sheet setf column NEW VALUE SHEET sheet The sheet s current column Source sheet page 21 Lisp file comment CONDITION Package net didierverna clon page 27 Methods comment CONDITION invalid argument comment CONDITION invalid value concealedp OBJECT Package net didierverna clon page 27 Methods Generic Function Generic Function Method Method Generic Function Generic Function Method Method Generic Function Method Method Generic Function 74 concealedp FACE face The face s concealed status Source face page 20 Lisp file contents OBJECT Package net didierverna clon page 27 Methods contents TEXT text The actual text string Source text page 13 Lisp file convert VALUED OPTION ARGUMENT Convert ARGUMENT to VALUED OPTION s value If ARGUMENT is invalid raise an invalid argument error Package net didierverna clon page 27 Source valued page 14 Lisp file Methods convert XSWITCH xswitch ARGUMENT Convert ARGUMENT to an XSWITCH value Source xswitch page 17 Lisp file convert ENUM enum ARGUMENT Convert ARGUMENT to an ENUM value Source enum page 17 Lisp file convert PATH path ARGUMENT Convert ARGUMENT to a PATH value Source path page 16 Lisp file convert LISPOBJ lispobj ARGUMENT Convert ARGUMENT to a LISPOBJ value Source lispobj page 16 Lisp file convert STROPT stropt ARGUME
30. e top padding page 89 method e right padding page 86 method e left padding page 80 method e visiblep page 91 method e name page 81 method name Slot The face name Initargs name Readers name page 81 generic function visiblep Slot Whether the face is visible Initargs visible Initform t Readers visiblep page 90 generic function left padding Slot The face left padding This property can take the following forms NUMBER the padding is relative to the enclosing face 104 The Clon Reference Manual SELF the padding is set to wherever the face happens to be opened lt NUMBER gt ABSOLUTE the padding is set in absolute value lt NUMBER gt RELATIVE TO lt FACE NAME gt the padding is set rela tively to a parent face named FACE NAME Initargs padding left Initform 0 Readers left padding page 79 generic function right padding Slot The face right padding This property can take the following forms NUMBER the padding is relative to the enclosing face SELF the padding is set to wherever the face happens to be closed lt NUMBER gt ABSOLUTE the padding is set in absolute value lt NUMBER gt RELATIVE TO lt FACE NAME gt the padding is set rela tively to a parent face named FACE NAME Initargs padding right Initform Inet didierverna clon self Readers right padding page 86 generic function top padd
31. page 54 function cmdline option value page 54 function setf cmdline option value page 54 function cmdline options page 73 method setf cmdline options page 73 method context page 100 class copy cmdline option page 55 function error handler page 76 method exit abnormally page 56 function highlight page 78 method invalid negated equal syntax page 94 condition invalid short equal syntax page 95 condition line width page 80 method make cmdline option page 58 function mapoptions page 81 method negated pack page 81 method postfix page 83 method potential pack p page 84 method print error page 64 function read call page 65 function read long name page 65 function restart on error page 66 function restartable cmdline junk error page 66 function search option page 68 function search option by abbreviation page 68 function search option by name page 68 function search path page 86 method search sticky option page 68 function short pack page 87 method synopsis page 89 method theme page 89 method Chapter 4 Files 25 unknown cmdline option error page 96 condition unrecognized negated call error page 97 condition unrecognized short call error page 97 condition untraverse page 90 method with context error handler page 52 macro 4 1 31 setup setup lisp Parent net didierverna clon
32. page 81 method Direct slots item Slot The option s name as it appears on the command line Initargs name item Readers name page 81 generic function argument Slot The option s command line argument Initargs argument Readers argument page 70 generic function Chapter 6 Definitions unrecognized negated call error An error related to an unrecognized negated call Package net didierverna clon page 27 Source context page 23 Lisp file Direct superclasses Direct methods Direct slots item cmdline error page 91 condition negated call page 81 method The unrecognized negated call on the command line Initargs Readers negated call item negated call page 81 generic function unrecognized short call error An error related to an unrecognized short call Package net didierverna clon page 27 Source context page 23 Lisp file Direct superclasses Direct methods Direct slots item cmdline error page 91 condition short call page 86 method The unrecognized short call on the command line Initargs Readers 6 2 7 Structures cmdline option short call item short call page 86 generic function Package net didierverna clon page 27 Source context page 23 Lisp file Direct superclasses structure object Direct slots name Readers Writers option Readers Writers cmdline option name page 54 fun
33. setf highlight property instance name page 58 function highlight property instance p page 58 function highlight property instance value page 58 function setf highlight property instance value page 58 function highlightp page 78 generic function highlightp page 78 method home directory page 58 function home directory page 93 condition i reader page 58 function in readtable page 51 macro intensity page 78 generic function Chapter 5 Packages 33 e intensity page 78 method e invalid argument page 93 condition e invalid cmdline argument page 94 condition e invalid environment value page 94 condition e invalid negated equal syntax page 94 condition e invalid negated syntax page 94 condition e invalid short equal syntax page 95 condition e invalid value page 95 condition e inversep page 79 generic function e inversep page 79 method e italicp page 79 generic function e italicp page 79 method e item page 79 generic function e item page 79 method e item page 106 class e item separator page 79 generic function e item separator page 79 method e items page 79 generic function e items page 79 method e junk page 79 generic function e junk page 79 method e left padding page 79 generic function e left padding page 80 method e line width page 80 generic functio
34. to yes no ARGUMENT TYPE is one of required mandatory or optional required and mandatory are synonyms It defaults to optional ENV VAR is the switch s associated environment variable It defaults to nil DEFAULT VALUE is the switch s default value if any When HIDDEN the option doesn t appear in help strings Package net didierverna clon page 27 Source switch page 15 Lisp file make synopsis amp rest KEYS amp key POSTFIX ITEM MAKE DEFAULT Function Make a new SYNOPSIS POSTFIX is a string to append to the program synopsis in case it accepts a remainder If MAKE DEFAULT make the new synopsis the default one Package net didierverna clon page 27 Source synopsis page 19 Lisp file make text amp rest KEYS amp key CONTENTS HIDDEN Function Make a new text CONTENTS is the actual text to display When HIDDEN the text doesn t appear in help strings Package net didierverna clon page 27 Source text page 13 Lisp file 48 The Clon Reference Manual make xswitch amp rest KEYS amp key SHORT NAME LONG NAME Function DESCRIPTION ARGUMENT NAME ARGUMENT TYPE ENUM ENV VAR DEFAULT VALUE HIDDEN Make a new xswitch SHORT NAME is the xswitch s short name without the dash It defaults to nil LONG NAME is the xswitch s long name without the double dash It defaults to nil DESCRIPTION is the xswitch s description appearing in help strings It defaults to ni
35. winsize ws xpixel 00 69 winsize ws ypixel 70 G Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function i Generic Function Generic Function i Generic Function j Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function Generic Function 121 setf argument styles 70 setf cmdline options 73 setf column 73 setf error string 76 setf frames 76 setf no values
36. yes values e yes values page 91 method e argument styles e argunent styles page 70 method Direct slots argument styles Slot The possible argument styles The position of every argument style in the list must correspond to the position of the associated strings in the yes values and no values slots Type list Initargs argument styles Readers argument styles page 70 generic function Writers setf argument styles page 70 generic function yes values Slot The possible yes values Type list Initargs yes values Readers _ yes values page 91 generic function Writers setf yes values page 91 generic function Chapter 6 Definitions 113 no values Slot The possible no values Type list Initargs no values Readers no values page 82 generic function Writers setf no values page 82 generic function argument style Slot The selected argument style Type keyword Initargs argument style Initform yes no Readers argument style page 70 generic function Direct Default Initargs Initarg Value argument type optional argument styles yes no on off true false yup nope yeah nah yes values 2 yes on true yup yeah no values no off false nope nah synopsis Class The SYNOPSIS class This class handles the description of the program s command line options Package net didierverna clon page 27 Source synopsis pag
37. 0 generic function 107 Slot Slot Class Slot Slot 108 The Clon Reference Manual negatable Class The NEGATABLE Class This class implements the negated syntax for the switch based hierarchy Package net didierverna clon page 27 Source negatable page 15 Lisp file Direct superclasses standard object Direct subclasses switch base page 112 class Direct methods e retrieve from negated call page 85 method e negated pack char page 82 method e short syntax help spec prefix page 87 method option Class The OPTION class This is the base class for all options Package net didierverna clon page 27 Source option page 13 Lisp file Direct superclasses item page 106 class Direct subclasses e flag page 106 class e valued option page 114 class Direct methods e mapoptions page 81 method e retrieve from negated call page 85 method e retrieve from short call page 85 method e retrieve from long call page 85 method e initialize instance e initialize instance e negated pack char page 82 method e short pack char page 87 method e option sticky distance page 83 method e check name clash page 72 method e help spec page 77 method e untraverse page 90 method e env var page 75 method e description page 75 method e long name page 80 method e short name page 86 method Direct slots
38. 1 Sissies Lie eae ENE E 47 Make tii dp 47 MAkS IS WI ECM aE 48 map frames opui da be ee 51 mapoptiOns c celle a o lona 80 81 pateh optione iis ote vee We etd eas ee 62 maybe pop argument 66 eee eee eee eee 51 maybe push Ios an 52 Method setf argument styles 70 Method setf cmdline options 73 Method setf column 00 e eee 73 Method setf error string s sss 76 Method setf frames 0 e eee 76 Method setf no values eee ee 82 Method setf traversedp 0 89 Method setf yes values 0 91 Method argument sss 70 Method argument name s sss 70 Method argument required p 70 Method argument style ooococccocccccocco 70 Method argument styles sss 70 Method background 0 0 cee eee eee o 71 Method blink nuce tiene os mere men 71 Method bottom padding 000 71 Method check 0 cece cece eee eee 71 72 Method check name clash ss 72 Method clon options group 72 Method close frame ee cece eee o 73 Method cmdline options 4 73 Method column 0 cece cece e eee eee 73 Method comment 0c cece eee eee eee 73 Method concealedp 0e eee eee 74 Method contents 0
39. 27 Source path page 16 Lisp file stream line width STREAM amp aux HANDLE Function Get STREAM s line width Return two values the stream s line width or nil if it can t be computed typically when the stream does not denote a tty an error message if the operation failed Package net didierverna clon page 27 Source termio page 11 Lisp file tilde reader STREAM CHAR Function Read a series of string to be concatenated together Package net didierverna clon page 27 Source neta page 11 Lisp file try read sface tree PATHNAME Function Read an sface tree from PATHNAME if it exists or return nil Package net didierverna clon page 27 Source sheet page 21 Lisp file try read theme PATHNAME Function Read a theme from PATHNAME or PATHNAME cth if it exists or return nil Package net didierverna clon page 27 Source sheet page 21 Lisp file winsize ws col STRUCT Function setf winsize ws col VAR 32 STRUCT Function Package net didierverna clon page 27 Source Users didier cache common lisp sbcl 1 2 13 35 6102b24 macosx x64 Users didier winsize ws row STRUCT Function setf winsize ws row VAR 0 STRUCT Function Package net didierverna clon page 27 Source Users didier cache common lisp sbcl 1 2 13 35 6102b24 macosx x64 Users didier winsize ws xpixel STRUCT Function setf winsize ws xpixel VAR 33 STRUCT Function Package net didierverna clon
40. 57 function home directory page 58 function home directory page 93 condition list to string page 58 function macosp page 58 function maybe push page 52 macro putenv page 64 function remove keys page 65 function replace in keys page 52 macro replace key page 65 function replace keys page 66 function select keys page 69 function 4 1 9 core src item lisp Dependency util page 12 Lisp file Parent src page 9 module Chapter 4 Files 13 Location core src item lisp Internal Definitions e help spec page 77 generic function e help spec page 78 method e hiddenp page 78 method e item page 106 class e traversedp page 89 method e setf traversedp page 89 method e untraverse page 90 generic function e untraverse page 90 method 4 1 10 core src text lisp Dependency item page 12 Lisp file Parent src page 9 module Location core src text lisp Exported Definitions nake text page 47 function Internal Definitions e contents page 74 method e help spec page 77 method e make internal text page 61 function e text page 114 class e untraverse page 90 method 4 1 11 core src options option lisp Parent options page 9 module Location core src options option lisp Internal Definitions e check name clash page 72 generic function e check name clash page 72 method e ch
41. 8 Structure highlight frame esses 98 Structure highlight property instance 99 SWE Chia sie wee X ck ems XX REB QUE NEM 111 Switch base vs vis o eie ia 112 SYNOPSES vicars pee I eerte eet werd 113 System net didierverna clon 5 System net didierverna clon core 7 System net didierverna clon setup 7 System net didierverna clon setup termio 6 System net didierverna clon termio 5 129 unknown cmdline option error 96 unrecognized negated call error 97 unrecognized short call error 97 Valued 6ption sit cia eu Goes EN WOTP UIN 114 X XSWItCH iseia re Teie a a 116
42. 9 T Eidos 89 tilde reader i incid ci dais 69 topspadding 3 028 ase ieu LL tS e fp at 89 traversed ois ihe teenie Ws Man d aes de 89 try read sface tree sess 69 try read theme orrien reni nE nA u ne 69 btypespeC ice e ETIA AV DAET E TARRA 90 U underline ce a E te X 90 UltraVerse coop hend REN sowie LOER ERE D 90 V V lue 5 sos n Eros ses Eee tv eds 90 VETS LOMA mamas 48 VISIO a Gx NSE See m qs 90 91 W Wwinsize Wws COliii s ui a a 69 WINSTZE WS BOW ci wash ple red CVE A RS 69 Appendix A Indexes WinSiZ WS Xpixel Lenin a eae 69 winsize ws ypixel cece eee 70 Wwith context cg due Heer ATE S ANH 43 with context error handler 52 WlIth wWinSliZGe nik ecd m EE Rr RATER mesada 52 Y 125 126 A 3 Variables COntext kl laa 41 executablep ti id eee ees 49 highlight properties eee eee 50 iten NAMES S A a daa 50 readtable nia menit eee p D PER ES 50 release major level oooooococconccccco o 41 release minor level cee eee eee 41 release name 0 eee 41 release status hon 0 eee eee eee eee eee 41 release status level o o o o o ooooooooooo 41 SyDOPSIS Wii iba de pod 41 tLOCewinsZte ites css tages se eLbX 4g eta tardas 49 A argument dador arios 93 94 96 argument name 102 107 109 111 115 argument required p cee cece eee eee 115 argument style sencis teede tde gonata Peis
43. ALUE HIDDEN Make a new string option SHORT NAME is the option s short name without the dash It defaults to nil LONG NAME is the option s long name without the double dash It defaults to nil DESCRIPTION is the option s description appearing in help strings It defaults to nil ARGUMENT NAME is the option s argument name appearing in help strings Chapter 6 Definitions 47 ARGUMENT TYPE is one of required mandatory or optional required and mandatory are synonyms It defaults to optional ENV VAR is the option s associated environment variable It defaults to nil FALLBACK VALUE is the option s fallback value for missing optional arguments if any DEFAULT VALUE is the option s default value if any When HIDDEN the option doesn t appear in help strings Package net didierverna clon page 27 Source stropt page 16 Lisp file make switch amp rest KEYS amp key SHORT NAME LONG NAME Function DESCRIPTION ARGUMENT STYLE ARGUMENT TYPE ENV VAR DEFAULT VALUE HIDDEN Make a new switch SHORT NAME is the switch s short name without the dash It defaults to nil LONG NAME is the switch s long name without the double dash It defaults to nil DESCRIPTION is the switch s description appearing in help strings It defaults to nil ARGUMENT STYLE is the switch s argument display style It can be one of yes no on off true false yup nope or yeah nah It defaults
44. BOL Ss indentation to INDENT in X Emacs This function sets SYMBOL s common lisp indent function property If INDENT is a symbol use its indentation definition Otherwise INDENT is considered as an indentation definition Package net didierverna clon page 27 Source neta page 11 Lisp file close line SHEET Function Close all frames on SHEET s current line and go to next line Package net didierverna clon page 27 Source sheet page 21 Lisp file close sface SHEET Function Close SHEET s current sface Package net didierverna clon page 27 Source sheet page 21 Lisp file 54 The Clon Reference Manual closest match MATCH LIST amp key IGNORE CASE KEY amp aux MATCH LENGTH SHORTEST DISTANCE CLOSEST MATCH Return the LIST element closest to MATCH or nil If IGNORE CASE well ignore case KEY should provide a way to get a string from each LIST element Package net didierverna clon page 27 Source util page 12 Lisp file cmdline convert VALUED OPTION CMDLINE NAME CMDLINE ARGUMENT Convert CMDLINE ARGUMENT to VALUED OPTION s value Function Function This function is used when the conversion comes from a command line usage of VALUED OPTION called by CMDLINE NAME and intercepts invalid argument errors to raise the higher level invalid cmdline argument error instead Package net didierverna clon page 27 Source cmdline page 18 Lisp file cmdline option name INSTANCE se
45. Container Pi oy bes sh epee RU A See 18 4 1 24 core src group Tispisleii a oa ee 18 4 1 25 core src retrieval cmdline lisp cece eee eee ene ee 18 4 1 26 core src retrieval environ lisp see 19 4 127 core src SynopsSis lisp were eld Rie rapida 19 ii The Clon Reference Manual 4 1 28 core src output face lisp sesesse m 20 4 1 29 core src output sheet lisp sese nn 21 41 30 core src context lispii eee bebit ANUS pere bo TEE TEA iaa 23 41 31 setup setup lisp um p Ue HR ERRARE XE e Ed 25 A A d UD PERS ed a Gene hem Wet idc HER RE 2T Ou met didierverna clOn c c neu A eee ww rene Re ae 27 5 2 net didierverna clon setup cece nnn 39 6 Definitions s vedo Mate as a ee NE SORA A Al 6 L Exported definitions io daa jot oR eee PE he bk eal eee ated 41 6 1 1 Special variables eyed iG leat cad As 41 0 1 2 Macross 20 06 peek A a Seth dane eae D vob een eee EN E a 42 6 1 3 F ncllong8 ib a da 43 6 2 Internal definitions ui dina emi edente bte pd on ee e b et edad 49 6 2 T ICONSHAM S e mineria S peut na exe A Ede ESL ER Mt EE ER di xa tt 49 6 2 2 Special variables i uocu keeper p RR AC OU EDEN E esr ues 49 0 2533 Macros ai A E MOSS ete voe 50 T E OTEA TOI ET ET E ET E E A TA A 52 6 2 5 Generic functions caca 70 6 2 0 Conditions cara aa a a AU ad 91 0 21 ISTTUCLUFES gt wae ope inten dd pat a ia Fede b dae 97 6 28 Classes A E ePDEPTTEIR RN 99 Appendix A Indexes
46. DEFAULT VALUE HIDDEN Make a new internal Clon specific enum option LONG NAME is the option s long name sans the clon prefix Internal options don t have short names DESCRIPTION is the options s description ARGUMENT NAME is the option s argument name appearing in help strings ARGUMENT TYPE is one of required mandatory or optional required and mandatory are synonyms It defaults to optional ENUM is the set of possible values ENV VAR is the option s associated environment variable sans the CLON_ prefix It defaults to nil FALLBACK VALUE is the option s fallback value for missing optional arguments if any DEFAULT VALUE is the option s default value if any When HIDDEN the option doesn t appear in help strings Package net didierverna clon page 27 Source enum page 17 Lisp file make internal flag LONG NAME DESCRIPTION amp rest KEYS amp key Function ENV VAR HIDDEN Make a new internal Clon specific flag LONG NAME is the flag s long name sans the clon prefix Internal options don t have short names DESCRIPTION is the flag s description ENV VAR is the flag s associated environment variable sans the CLON prefix It default to nil When HIDDEN the option doesn t appear in help strings Package net didierverna clon page 27 Source flag page 14 Lisp file make internal lispobj LONG NAME DESCRIPTION amp rest KEYS amp key Fu
47. E Package net didierverna clon page 27 Source sheet page 21 Lisp file Function Function Function Function Function Function Function Function Chapter 6 Definitions 57 free winsize OBJECT40 Function Package net didierverna clon page 27 Source Users didier cache common lisp sbcl 1 2 13 35 6102b24 macosx x64 Users didier get top padding SFACE ITEMS Function Return top padding of the next item in ITEMS that will print under SFACE Package net didierverna clon page 27 Source sheet page 21 Lisp file getenv VARIABLE Function Get environment VARIABLE s value VARIABLE may be null Package net didierverna clon page 27 Source util page 12 Lisp file help spec items will print SFACE ITEMS Function Return t if at least one of ITEMS will print under SFACE Package net didierverna clon page 27 Source sheet page 21 Lisp file highlight frame highlight property instances INSTANCE Function setf highlight frame highlight property instances VALUE Function INSTANCE Package net didierverna clon page 27 Source sheet page 21 Lisp file highlight frame left margin INSTANCE Function setf highlight frame left margin VALUE INSTANCE Function Package net didierverna clon page 27 Source sheet page 21 Lisp file highlight frame p OBJECT Function Package net didierverna clon page 27 Source sheet page 21 Lisp file highligh
48. Function Package net didierverna clon page 27 Methods highlight CONTEXT context Method Clon s output highlight mode Source context page 23 Lisp file highlightp OBJECT Generic Function Package net didierverna clon page 27 Methods highlightp SHEET sheet Method Whether to highlight SHEET s output Source sheet page 21 Lisp file intensity OBJECT Generic Function Package net didierverna clon page 27 Methods intensity FACE face Method The face intensity Source face page 20 Lisp file Chapter 6 Definitions inversep OBJECT Package net didierverna clon page 27 Methods inversep FACE face The face s inverse video status Source face page 20 Lisp file italicp OBJECT Package net didierverna clon page 27 Methods italicp FACE face The face s italic status Source face page 20 Lisp file item CONDITION Package net didierverna clon page 27 Methods item CONDITION cmdline error item separator OBJECT Package net didierverna clon page 27 Methods item separator FACE face The face item separator Source face page 20 Lisp file items OBJECT Package net didierverna clon page 27 Methods items CONTAINER container The items in the container Source container page 18 Lisp file junk CONDITION Package net didierverna clon page 27 Methods junk CONDITION cmdline junk error left padding OBJECT Package net didiervern
49. ITCH Source xswitch page 17 Lisp file check ENUM enum VALUE Check that VALUE is valid for ENUM Source enum page 17 Lisp file check PATH path VALUE Check that VALUE is valid for PATH Source path page 16 Lisp file check LISPOBJ lispobj VALUE Check that VALUE is valid for LISPOBJ Source lispobj page 16 Lisp file Generic Function Method Method Method Method 72 The Clon Reference Manual check STROPT stropt VALUE Method Check that VALUE is valid for STROPT Source stropt page 16 Lisp file check SWITCH switch VALUE Method Check that VALUE is valid for SWITCH Source switch page 15 Lisp file check name clash ITEM1 ITEM2 Generic Function Check for name clash between ITEM1 s options and ITEM2 s options Package net didierverna clon page 27 Source option page 13 Lisp file Methods check name clash CONTAINER1 container Method CONTAINER container Check for name clash between CONTAINER1 s options and CONTAINER2 s ones Source container page 18 Lisp file check name clash ITEM1 CONTAINER container Method Check for name clash between ITEM1 s options and CONTAINER s ones Source container page 18 Lisp file check name clash CONTAINER container ITEM2 Method Check for name clash between CONTAINER s options and ITEM2 s ones Source container page 18 Lisp file check name clash ITEMI TEXT text Method D
50. LUMN Function Reach COLUMN on SHEET by princ ing spaces Package net didierverna clon page 27 Source sheet page 21 Lisp file read argument Function Read an option argument from standard input Package net didierverna clon page 27 Source valued page 14 Lisp file Chapter 6 Definitions 65 read call amp optional NEGATED Function Read an option s call or pack from standard input If NEGATED read a negated call or pack Otherwise read a short call or pack Package net didierverna clon page 27 Source context page 23 Lisp file read env val ENV VAR Function Read ENV VAR s new value from standard input Package net didierverna clon page 27 Source environ page 19 Lisp file read long name Function Read an option s long name from standard input Package net didierverna clon page 27 Source context page 23 Lisp file read sface tree PATHNAME Function Read an sface tree from PATHNAME Package net didierverna clon page 27 Source sheet page 21 Lisp file read value Function Read an option value from standard input Package net didierverna clon page 27 Source valued page 14 Lisp file release status number RELEASE STATUS Function Package net didierverna clon setup page 39 Source setup page 25 Lisp file remove keys KEYS amp rest REMOVED Function Return a new property list from KEYS without REMOVED ones Package net didierverna clon page 27 So
51. LpUt neesii r Ae Bsp tae eee ER QUEE EE es 10 de estado odis et ee ee een eee ee ds e dl ee ort t 11 dl SP A A etti ees tede die mili ebat 11 4 1 1 net didierverna clon vas vi ca Ei add 11 4 1 2 net didierverna clon termio asd sese eee 11 4 1 3 net didierverna clon core asd cece eee ees 11 4 1 4 net didierverna clon setup asd 0 cece eee eee nnn 11 4 1 5 termio sbcl constants Llisp ccc n ne 11 4 5 0 termio termio liSp scsi a ae ae oe 11 ATT Core mMetavlisp ir rta ale dyin des 11 418 core src til VASP isd oie A SHAG RU ee Dea ep A 12 41 9 core src item liSp o end heehee eaten eee ruere ER 12 4110 COre src text Pi Mee sea eee Nev CE E Dr soa ee 13 4 1 11 core src options option lisp sees 13 4 1 12 core src options flag lisp ssssssseseees eh en 14 4 1 13 core src options valued liSP ooocooocconcconcco e 14 4 1 14 core src options negatable lisp see een eee 15 4 1 15 core src options switch base lisp cc cece eee nee ene 15 4 1 16 core src options switch lisp cece cee eee ened 15 4 1 17 core src options stropt lisp cece m 16 4 1 18 core src options lispobj lisp s see 16 4 1 19 core src options path lisp sseseee me 16 4 1 20 core src options enum base lisp eene 17 4 1 21 core src options enum lisp sesse e ne nen 17 4 1 22 core src options xswitch lisp cece eee nne 17 4 1 23 Core sre
52. Method switch base The possible yes values Source switch base page 15 Lisp file 6 2 6 Conditions cmdline error Condition An error related to a command line item Package net didierverna clon page 27 Source cmdline page 18 Lisp file Direct superclasses error Direct subclasses e cmdline option error page 92 condition e invalid short equal syntax page 95 condition e invalid negated equal syntax page 94 condition e cmdline junk error page 91 condition e unrecognized short call error page 97 condition e unrecognized negated call error page 97 condition e unknown cmdline option error page 96 condition Direct methods item page 79 method Direct slots item Slot The concerned command line item Initargs item Readers item page 79 generic function cmdline junk error Condition An error related to a command line piece of junk Package net didierverna clon page 27 Source context page 23 Lisp file Direct superclasses cmdline error page 91 condition 92 The Clon Reference Manual Direct methods junk page 79 method Direct slots item Slot The piece of junk appearing on the command line Initargs junk item Readers junk page 79 generic function cmdline option error Condition An error related to a command line known option Package net didierverna clon page 27 Source cmdline page 18 Lisp file Direct su
53. NT Convert ARGUMENT to an STROPT value Source stropt page 16 Lisp file convert SWITCH switch ARGUMENT Convert ARGUMENT to a SWITCH value Source switch page 15 Lisp file copy instance INSTANCE amp optional SUBCLASS Return a copy of INSTANCE The Clon Reference Manual Method Generic Function Method Generic Function Method Method Method Method Method Method Generic Function Copy is either an object of INSTANCE s class or INSTANCE s SUBCLASS if given Package net didierverna clon page 27 Source util page 12 Lisp file Methods Chapter 6 Definitions 75 copy instance INSTANCE amp optional SUBCLASS Method Return a copy of INSTANCE Both instances share the same slot values crossed out p OBJECT Generic Function Package net didierverna clon page 27 Methods crossed out p FACE face Method The face s crossed out status Source face page 20 Lisp file default value OBJECT Generic Function Package net didierverna clon page 27 Methods default value VALUED OPTION valued option Method The option s default value Source valued page 14 Lisp file description OBJECT Generic Function Package net didierverna clon page 27 Methods description OPTION option Method The option s description Source option page 13 Lisp file enum OBJECT Generic Function Package net didierverna clon page 27 Methods enum ENUM BASE
54. NT to VALUED OPTION s value Available restarts are use default value return OPTION s default value use value return another already converted value use argument return the conversion of another argument Package net didierverna clon page 27 Source valued page 14 Lisp file restartable environment convert VALUED OPTION ENV VAL Function Restartably convert ENV VAL to VALUED OPTION s value This function is used when the conversion comes from an environment variable associated with VALUED OPTION Available restarts are use default value return VALUED OPTION s default value use value return another already converted value use argument return the conversion of another argument modify env modify the environment variable s value Package net didierverna clon page 27 Source environ page 19 Lisp file restrict because REASON Function Put Clon in restricted mode because of REASON Package net didierverna clon setup page 39 Source setup page 25 Lisp file safe left margin SHEET MARGIN Function Return either MARGIN or a safe value instead To be safe margin must be greater than the current left margin and smaller than the currently available margin Package net didierverna clon page 27 Source sheet page 21 Lisp file safe right margin SHEET LEFT MARGIN MARGIN Function Return either MARGIN or a safe value instead To be safe margin must be greater than LEFT MA
55. OPSIS synopsis A postfix to the program synopsis Source synopsis page 19 Lisp file potential pack OBJECT Package net didierverna clon page 27 Methods Generic Function Method Generic Function Method Generic Function Method Generic Function Method Method Generic Function 84 The Clon Reference Manual potential pack SYNOPSIS synopsis Method The potential pack string Source synopsis page 19 Lisp file potential pack p PACK THERE Generic Function Return t if PACK is a potential pack in THERE Package net didierverna clon page 27 Source synopsis page 19 Lisp file Methods potential pack p PACK CONTEXT context Method Return t if PACK a string is a potential pack in CONTEXT Source context page 23 Lisp file potential pack p PACK SYNOPSIS synopsis Method Return t if PACK is a potential pack for SYNOPSIS print help spec SHEET HELP SPEC Generic Function Print HELP SPEC on SHEET Package net didierverna clon page 27 Source sheet page 21 Lisp file Methods print help spec SHEET HELP SPEC before Method print help spec SHEET CHAR character Method Print CHAR on SHEET with the current face print help spec SHEET CHAR VECTOR simple vector Method Print CHAR VECTOR on SHEET with the current face print help spec SHEET STRING string Method Print STRING on SHEET with the current face print help spec SHEET HELP SPEC list Method Op
56. ORT NAME LONG NAME If OPTION matches return the name that matched Package net didierverna clon page 27 Source option page 13 Lisp file open line SHEET Open all frames on SHEET s current line Package net didierverna clon page 27 Source sheet page 21 Lisp file open next line SHEET Close SHEET s current line and open the next one Package net didierverna clon page 27 Source sheet page 21 Lisp file open sface SHEET SFACE Create a frame for SFACE and open it Package net didierverna clon page 27 Source sheet page 21 Lisp file option abbreviation distance OPTION PARTIAL NAME Return the distance between OPTION s long name and PARTIAL NAME Function Function Function Function Function Function Function If PARTIAL NAME does not abbreviate OPTION s long name return MOST POSITIVE FIXNUM Package net didierverna clon page 27 Source option page 13 Lisp file option call p STR Return true if STR looks like an option call Package net didierverna clon page 27 Source cmdline page 18 Lisp file Function Chapter 6 Definitions 63 parent generation FACE PARENT NAME Function Return FACE s parent generation for PARENT NAME That is 1 if PARENT NAME names FACE s parent 2 if it names its grand parent etc If PARENT NAME does not name one of FACE s ancestors trigger an error Package net didierverna clon page 27 Sou
57. RGIN and smaller than the currently available right margin Package net didierverna clon page 27 Source sheet page 21 Lisp file search branch FACE NAMES Function Search for a branch of faces named NAMES starting at FACE The branch is searched for as a direct subbranch of FACE or as a direct subbranch of FACE s ancestors If a branch is found return its leaf face Otherwise return nil Package net didierverna clon page 27 Source face page 20 Lisp file 68 The Clon Reference Manual search face FACE NAME optional ERROR ME Function Search for a face named NAME starting at FACE The face is looked for as a direct subface of FACE in which case it is simply returned or up in the hierarchy and by successive upper branches in which case it is copied and attached to FACE If ERROR ME trigger an error if no face is found otherwise return nil Package net didierverna clon page 27 Source face page 20 Lisp file search option CONTEXT amp rest KEYS amp key SHORT NAME Function LONG NAME PARTIAL NAME Search for an option in CONTEXT The search is done with SHORT NAME LONG NAME or PARTIAL NAME In case of a PARTIAL NAME search look for an option the long name of which begins with it In case of multiple matches by PARTIAL NAME the longest match is selected When such an option exists return wo values the option itself the name used to find the option possibly completed if partial Packa
58. Return OPTION s short pack character if OPTION s argument is optional Source valued page 14 Lisp file short pack char OPTION option amp optional AS STRING Method Return OPTION s potential pack character short syntax help spec prefix OPTION Generic Function Return the help specification prefix for OPTION s short call Package net didierverna clon page 27 Source valued page 14 Lisp file Methods short syntax help spec prefix OPTION negatable Method Source negatable page 15 Lisp file short syntax help spec prefix OPTION Method valued option sibling OBJECT Generic Function Package net didierverna clon page 27 Methods sibling SFACE sface Method The SFace s raw sibling Source sheet page 21 Lisp file stream ioctl output handle STREAM Generic Function Return STREAM s ioctl output handle or NIL Package net didierverna clon page 27 Source termio page 11 Lisp file Methods 88 The Clon Reference Manual stream ioctl output handle STREAM synonym stream stream ioctl output handle STREAM two way stream Method stream ioctl output handle STREAM fd stream stream ioctl output handle STREAM stringify VALUED OPTION VALUE Transform VALUED OPTION s VALUE into an argument This is the opposite of argument conversion Package Source Methods net didierverna clon page 27 valued page 14 Lisp file stringify XSWITCH xswitch VALUE Transform XSWITCH
59. S STRING Return OPTION s negated pack character if any If AS STRING return a string of that character Package net didierverna clon page 27 Source option page 13 Lisp file Methods 81 Method Method Method Method Method Generic Function Method Method Method Generic Function Method Generic Function Method Method Generic Function 82 The Clon Reference Manual negated pack char NEGATABLE negatable amp optional Method AS STRING Return NEGATABLE s negated pack character if any Source negatable page 15 Lisp file negated pack char OPTION option amp optional Method AS STRING Return nil only the switch hierarchy is negated pack able no values OBJECT Generic Function setf no values NEW VALUE OBJECT Generic Function Package net didierverna clon page 27 Methods no values SWITCH BASE switch base Method setf no values NEW VALUE SWITCH BASE Method switch base The possible no values Source switch base page 15 Lisp file open frame SHEET FRAME Generic Function Open FRAME on SHEET Package net didierverna clon page 27 Source sheet page 21 Lisp file Method Combination progn Options most specific last Methods open frame SHEET FRAME frame progn Method Reach the frame s left margin open frame SHEET FRAME highlight frame progn Method Reach the frame s left margin and output its highlight propertie
60. STANCE Package net didierverna clon page 27 Source sheet page 21 Lisp file current frame SHEET Return SHEET s current frame Package net didierverna clon page 27 Source sheet page 21 Lisp file current left margin SHEET Return SHEET s current left margin Package net didierverna clon page 27 Source sheet page 21 Lisp file current right margin SHEET Return SHEET s current right margin Package net didierverna clon page 27 Source sheet page 21 Lisp file current sface SHEET Return SHEET s current sface or nil Package net didierverna clon page 27 Source sheet page 21 Lisp file directory pathname p PATHNAME Return true if PATHNAME denotes a directory Package net didierverna clon page 27 Source path page 16 Lisp file environment convert VALUED OPTION ENV VAL Convert ENV VAL to VALUED OPTION s value 95 Function Function Function Function Function Function Function Function Function Function This function is used when the conversion comes from an environment variable associated with VALUED OPTION and intercepts invalid argument errors to raise the higher level invalid environment value error instead Package net didierverna clon page 27 Source environ page 19 Lisp file 56 The Clon Reference Manual exit abnormally ERROR Print ERROR on ERROR OUTPUT and exit with status code 1 P
61. Special Variable Special Variable Special Variable Special Variable Special Variable 42 The Clon Reference Manual configuration Special Variable The Clon configuration settings This variable contains a property list of configuration options Current options are swank eval in emacs Boolean restricted Boolean dump Boolean See section A 1 of the user manual for more information Package net didierverna clon setup page 39 Source setup page 25 Lisp file 6 1 2 Macros defgroup amp rest KEYS amp key HEADER HIDDEN amp body FORMS Macro Define a new group KEYS are initargs to MAKE GROUP currently only header Each form in FORMS will be treated as a new item The CAR of each form is the name of the operation to perform TEXT GROUP or an option class name The rest are the arguments to the MAKE lt OP gt function or the DEFGROUP macro Package net didierverna clon page 27 Source group page 18 Lisp file defsynopsis amp rest KEYS amp key POSTFIX MAKE DEFAULT amp body Macro FORMS Define a new synopsis Package net didierverna clon page 27 Source synopsis page 19 Lisp file do cmdline options OPTION NAME VALUE SOURCE amp key CONTEXT Macro amp body BODY Evaluate BODY over all command line options in CONTEXT OPTION NAME and VALUE are bound to each option s object name used on the command line and retrieved value Package net didierverna clon pa
62. T Package net didierverna clon page 27 Methods synopsis CONTEXT context The program synopsis Source context page 23 Lisp file theme OBJECT Package net didierverna clon page 27 Methods theme CONTEXT context The theme filename Source context page 23 Lisp file top padding OBJECT Package net didierverna clon page 27 Methods top padding HELP SPEC list Source sheet page 21 Lisp file top padding OTHER Source sheet page 21 Lisp file top padding FACE face The face top padding This property can take the following forms nil the output can start right away 0 the output should start on the next line N gt 0 there should be N empty lines before the output Source face page 20 Lisp file traversedp OBJECT setf traversedp NEW VALUE OBJECT Package net didierverna clon page 27 Methods traversedp ITEM item setf traversedp NEW VALUE ITEM item The item s traversal state Source item page 12 Lisp file 89 Generic Function Method Generic Function Method Generic Function Method Generic Function Method Method Method Generic Function Generic Function Method Method 90 The Clon Reference Manual typespec OBJECT Generic Function Package net didierverna clon page 27 Methods typespec LISPOBJ lispobj Method A type specifier the option s value should satisfy Source Lispobj page 16 Lis
63. The Clon Reference Manual The Command Line Options Nuker version 1 0 beta 24 Michael Brecker Didier Verna lt didier didierverna net gt This manual was generated automatically by Declt 2 0 Kathryn Janeway on Mon Jul 13 18 46 17 2015 GMT 1 Copyright c 2010 2012 2015 Didier Verna Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying provided also that the section entitled Copy ing is included exactly as in the original Permission is granted to copy and distribute translations of this manual into an other language under the above conditions for modified versions except that this permission notice may be translated as well Table of Contents COPIE nao E sd pao Tano 1 15 Introduction o AS EO ence DAE 3 27 NS ES ASAS A N Reg Ee 5 2 1 net didierverna ClOon oA A A A a e d ARD RR dte adi 5 2 2 net didierverna clon termio na a eee eee eee 5 2 3 net didierverna clon setup termio 2 ect men 6 2 4 net didierverna clom COLO miii eee rue es ee ere ea eae BS ber eds 7 2 5 net didierverna clon setup oaie terusir deanei een n 7 9 Modales A A E ata 9 A NO arene LUS 9 3 2 Core src options ta A eee RN EEG Ure 9 Eore src retrieval iaa he ede breed eun be 10 3 4 Core SrG OU
64. a clon page 27 Methods 79 Generic Function Method Generic Function Method Generic Function Method Generic Function Method Generic Function Method Generic Function Method Generic Function 80 The Clon Reference Manual left padding FACE face Method The face left padding This property can take the following forms NUMBER the padding is relative to the enclosing face SELF the padding is set to wherever the face happens to be opened lt NUMBER gt ABSOLUTE the padding is set in absolute value lt NUMBER gt RELATIVE TO lt FACE NAME gt the padding is set rela tively to a parent face named FACE NAME Source face page 20 Lisp file line width OBJECT Generic Function Package net didierverna clon page 27 Methods line width CONTEXT context Method The line width for help display Source context page 23 Lisp file line width SHEET sheet Method The sheet s line width Source sheet page 21 Lisp file long name OBJECT Generic Function Package net didierverna clon page 27 Methods long name OPTION option Method The option s long name Source option page 13 Lisp file make face tree DEFINITION amp optional FACE CLASS Generic Function Make a FACE CLASS face tree from DEFINITION Package net didierverna clon page 27 Source face page 20 Lisp file Methods make face tree DEFINITION list amp optional Meth
65. ackage net didierverna clon page 27 Source context page 23 Lisp file face highlight property set p FACE PROPERTY Return t if PROPERTY is set explicitely in FACE Package net didierverna clon page 27 Source face page 20 Lisp file face highlight property value FACE PROPERTY Return PROPERTY s value in FACE Function Function Function Since faces inherit highlight properties the actual value might come from one of FACE s ancestors if PROPERTY is not et return nil Package net didierverna clon page 27 Source face page 20 Lisp file find sface SFACE NAME amp aux SIBLING SUB SFACE Find an sface starting at SFACE named NAME Function If the sface can t be found in SFACE s face tree find one in SFACE s sibling instead and make a copy of it Package net didierverna clon page 27 Source sheet page 21 Lisp file flush sheet SHEET Flush SHEET Package net didierverna clon page 27 Source sheet page 21 Lisp file frame left margin INSTANCE setf frame left margin VALUE INSTANCE Package net didierverna clon page 27 Source sheet page 21 Lisp file frame p OBJECT Package net didierverna clon page 27 Source sheet page 21 Lisp file frame right margin INSTANCE setf frame right margin VALUE INSTANCE Package net didierverna clon page 27 Source sheet page 21 Lisp file frame sface INSTANCE setf frame sface VALUE INSTANC
66. acro Macro Macro Macro Macro Each clause looks like PROPERTY NAME VALUE OR VALUE LIST ESCAPE SEQUENCE The value matching part will itself be enclosed in an ECASE expression In addition the special clause syntax BOOLEAN lt PROPERTY NAME gt lt YES gt lt NO gt is a shortcut for PROPERTY NAME on t YES off nil NO Package net didierverna clon page 27 Source sheet page 21 Lisp file in readtable NAME Set the current readtable to the value of NAME READTABLE Package net didierverna clon page 27 Source neta page 11 Lisp file map frames FUNCTION SHEET amp key REVERSE Map FUNCTION over SHEET s frames If REVERSE map in reverse order Package net didierverna clon page 27 Source sheet page 21 Lisp file maybe pop argument CMDLINE OPTION CMDLINE ARGUMENT Pop OPTION s argument from CMDLINE if needed If so store it in CMDLINE ARGUMENT Package net didierverna clon page 27 Source cmdline page 18 Lisp file Macro Macro Macro 52 The Clon Reference Manual maybe push OBJECT PLACE amp aux THE OBJECT Macro Like push but only if OBJECT is non nil Package net didierverna clon page 27 Source util page 12 Lisp file replace in keys KEY VAL KEYS THE KEY FORM Macro Replace every occurrence of THE KEY in KEYS with FORM At every KEYS round KEY and VAL are bound to the current key value pair FORM is evaluated each time an
67. ake internal xswitch page 61 function e stringify page 88 method e xswitch page 116 class 18 The Clon Reference Manual 4 1 23 core src container lisp Dependency options page 9 module Parent src page 9 module Location core src container lisp Internal Definitions e check name clash page 72 method e check name clash page 72 method e check name clash page 72 method e container page 99 class e help spec page 77 method e items page 79 method e untraverse page 90 method 4 1 24 core src group lisp Dependency container page 18 Lisp file Parent src page 9 module Location core src group lisp Exported Definitions e defgroup page 42 macro e nake group page 45 function Internal Definitions e defgroup page 50 macro e group page 106 class e header page 77 method e help spec page 77 method 4 1 25 core src retrieval cmdline lisp Parent retrieval page 10 module Location core src retrieval cmdline lisp Internal Definitions e argument popable p page 53 function e cmdline convert page 54 function e cmdline error page 91 condition e cmdline option error page 92 condition e invalid cmdline argument page 94 condition e invalid negated syntax page 94 condition e maybe pop argument page 51 macro e missing cmdline argument page 95 condition e option call p page 62 function
68. c Eder da 58 Function home directory esses 58 Function izreden iniciada rodeos 58 Function list to string 06 58 Function macosp l i kie Rx uh ees 58 Function make cmdline option 58 Function make context 00 eee eee eee eee 44 Function make enum 0 0 0 eee eee eee eee 45 Function make flag 0 cece eee eee ee 45 Function make frame 00 co 58 Function make group cene areen PL ees 45 Function make highlight frame 59 Function make highlight property instance 59 Function make internal enum 59 Function make internal flag 59 Function make internal lispobj 59 Function make internal path 60 Function make internal stropt 60 Function make internal switch 61 Function make internal text 61 Function make internal xswitch 61 Function make lispobj 0 cece eee eee 45 Function make path sse eee 46 Function make raw face tree 61 Function make raw sface o ooccococccccccccco 62 Function make sheet 00 eee eee 62 Function make stropt cee eee eee 46 Function make switch ee eee eee 47 Function make synopsis sssesss 47 Function make text 0 cee eee eee ee
69. c function e default value page 75 method e defoption page 51 macro e fallback value page 76 method e help spec page 77 method e invalid argument page 93 condition e invalid value page 95 condition e option sticky distance page 83 method e read argument page 64 function e read value page 65 function e restartable check page 66 function e restartable convert page 67 function e short pack char page 87 method e short syntax help spec prefix page 87 generic function Chapter 4 Files 15 e short syntax help spec prefix page 87 method e stringify page 88 generic function e valued option page 114 class 4 1 14 core src options negatable lisp Dependency valued page 14 Lisp file Parent options page 9 module Location core src options negatable lisp Internal Definitions e negatable page 108 class e negated pack char page 82 method e short syntax help spec prefix page 87 method 4 1 15 core src options switch base lisp Dependency negatable page 15 Lisp file Parent options page 9 module Location core src options switch base lisp Internal Definitions e argument style page 70 method e argunent styles page 70 method e setf argument styles page 70 method e no values page 82 method e setf no values page 82 method e switch base page 112 class e yes values page 91 method e set
70. ce eee ee eee 52 Function allocate winsize 53 Function argument popable p 53 Function attach face tree suus 53 Function available right margin 53 Function beginning of string p 53 Function clindent soiien ce eee eee eee 53 Function close line 000 53 Function close sface se eee eee 53 Function closest match eee e eee eee 54 Function cmdline kg sa eee aes 43 Function cmdline convert 000 54 Function cmdline option name 54 Function cmdline option option 54 Function cmdline option p esses 54 Function cmdline option source 54 Function cmdline option value 54 Function cmdline options p 0 43 Function cmdline p eee 43 Function complete string sess 54 Function configuration cee eee 43 Function configure sss 44 Function copy cmdline option 55 Function copy frame 0 cee eee oo 55 Function copy highlight frame 55 Function copy highlight property instance 55 Function current frame ee eee eee ee 55 The Clon Reference Manual Function current left margin 55 Function current right margin 55 Function curr
71. core page 7 system e net didierverna clon termio page 5 system for feature net didierverna clon termio Definition file net didierverna clon asd page 11 Lisp file 2 2 net didierverna clon termio Long Name The Command Line Options Nuker termio library Author Didier Verna 6 The Clon Reference Manual Contact didier didierverna net Home Page http www lrde epita fr didier software lisp clon php Source Control https github com didierverna clon License BSD Description Clon s support for termio tty geometry and fontification Long Description Clon s termio library provides automatic detection of tty geometry and ISO6429 coloring on terminals that support it For a more complete description of Clon see the net didierverna clon system If Feature net didierverna clon termio Defsystem Dependencies e net didierverna clon setup termio page 6 system e required module sb grovel for feature sbc1 Dependencies e sb posix for feature sbcl e cffi for feature and clisp net didierverna clon termio e net didierverna clon core page 7 system Definition file net didierverna clon termio asd page 11 Lisp file Components e sbc1 constants page 11 Lisp file e termio page 11 Lisp file 2 3 net didierverna clon setup termio Long Name The Command Line Options Nuker termio setup Author Didier Verna lt didier didierverna net gt Contact didier didierverna net Home Page ht
72. ction setf cmdline option name page 54 function cmdline option option page 54 function 97 Condition Slot Condition Slot Structure Slot Slot setf cmdline option option page 54 function 98 The Clon Reference Manual value Slot Readers cmdline option value page 54 function Writers setf cmdline option value page 54 function Source Slot Readers cmdline option source page 54 function Writers setf cmdline option source page 54 function frame Structure The FRAME structure This structure hold layout properties used for printing Package net didierverna clon page 27 Source sheet page 21 Lisp file Direct superclasses structure object Direct subclasses highlight frame page 98 structure Direct methods e close frame page 73 method e open frame page 82 method Direct slots sface Slot Readers frame sface page 56 function Writers setf frame sface page 56 function left margin Slot Readers frame left margin page 56 function Writers setf frame left margin page 56 function right margin Slot Readers frame right margin page 56 function Writers setf frame right margin page 56 function highlight frame Structure The HIGHLIGHT FRAME structure This structure holds both layout and highlight properties used for printing Package net didierverna clon page 27 Source sheet page 21 Lisp file Direct
73. ction frames Slot The stack of currently open frames Type list Readers frames page 76 generic function Writers setf frames page 76 generic function stropt Class The STROPT class This class implements options the values of which are strings Package net didierverna clon page 27 Source stropt page 16 Lisp file Direct superclasses valued option page 114 class Direct methods e convert page 74 method e check page 72 method e stringify page 88 method Direct slots argument name Slot Initform str switch Class The SWITCH class This class implements boolean options Package net didierverna clon page 27 Source switch page 15 Lisp file 112 The Clon Reference Manual Direct superclasses e valued option page 114 class e switch basel page 112 class Direct methods e initialize instance e convert page 74 method e check page 72 method e stringify page 88 method switch base Class The SWITCH BASE abstract class This class provides support for options including boolean values Package net didierverna clon page 27 Source switch base page 15 Lisp file Direct superclasses negatable page 108 class Direct subclasses e switch page 111 class e xswitch page 116 class Direct methods e initialize instance e initialize instance e argument style page 70 method e no values e no values page 82 method e
74. d e contents page 74 method Direct slots contents The actual text string Type string Initargs contents Readers contents page 74 generic function valued option The VALUED OPTION class This is the base class for options accepting arguments Slot Slot Slot Slot Class Slot Class Chapter 6 Definitions 115 Package Source net didierverna clon page 27 valued page 14 Lisp file Direct superclasses option page 108 class Direct subclasses Direct methods Direct slots e switch page 111 class e stropt page 111 class e lispobj page 107 class e path page 109 class e enum page 102 class e xswitch page 116 class e retrieve from environment page 84 method e retrieve from negated call page 85 method e retrieve from short call page 85 method e retrieve from long call page 85 method e initialize instance e initialize instance e help spec page 77 method e short syntax help spec prefix page 87 method e short pack char page 87 method e option sticky distance page 83 method e default value page 75 method e fallback value page 76 method e argument required p page 70 method e argument name page 70 method argument name Slot The option s argument display name Initargs argument name Initform arg Readers argument name page 70 generic funct
75. d should return a key value list Package net didierverna clon page 27 Source util page 12 Lisp file restartable invalid negated syntax error OPTION amp body BODY Macro Restartably throw an invalid negated syntax error The error relates to the command line use of OPTION BODY constitutes the body of the only restart available use short call and should act as if OPTION had been normally called by short name Package net didierverna clon page 27 Source cmdline page 18 Lisp file restartable spurious cmdline argument error OPTION NAME Macro ARGUMENT amp body BODY Restartably throw a spurious cmdline argument error The error relates to the command line use of OPTION called by NAME with ARGUMENT BODY constitutes the body of the only restart available discard argument and should act as if ARGUMENT had not been provided Package net didierverna clon page 27 Source cmdline page 18 Lisp file with context error handler CONTEXT amp body BODY Macro Execute BODY with CONTEXT s error handler bound for CONDITION Package net didierverna clon page 27 Source context page 23 Lisp file with winsize VAR35 amp rest FIELD VALUES 36 amp body BODY37 Macro Package net didierverna clon page 27 Source Users didier cache common lisp sbcl 1 2 13 35 6102b24 macosx x64 Users didier 6 2 4 Functions version TYPE MAJOR MINOR STATUS LEVEL NAME Function Package net didierverna clon setup
76. e 112 Slot backgro nd surrer soriano ver Rt 105 DIL Dii kust Doll d dod ih dene Odea ee EE 105 Slot bottom padding csse 104 Slot clon options group 000 114 Slot cmdline options 0 0004 101 slot column dadas Queer DATE 111 Slot Comment anna 94 95 Slot concealedp cries ea aio 105 Slot contents cien bee ai va 114 Slot crossed out p 0 eee eee eee 105 Slot default value macori naus e na SE eee ees 116 Slot description s02isecieeiees e es 109 Slot enum aiaia i a oes 102 116 Slot env ya i esent otoi ide 92 109 Sl tyerr or hand lefi isyeen ienai reena eee eee 101 Slot error string is ecerbere epi ir ees 93 Slot fallback value 0 eee eee eee eee 115 Slot foreground ee AE ERR EE Res 105 Slot fram dp vovv cone ee LONE EEYS 105 Slot frames ef XR MEILEN RE 111 Slot header cin E RID E WIDE eR 106 Slot Hiddenps roces pu da ra i 107 Slot highlight 2 80x PERDRE 101 Slot highlight property instances 99 Slot highlightp t et t Res 111 Slot intensity e daiwa ee o es 104 olot inVers p iere pnis ive e pANPU US 105 Slot tati Cpe r ca acces auc Y gw e geese awe 105 Slob cit A Qe ards R 91 92 96 97 Slot item separator 000 00 104 Slot TEM hy saute heels ds a Leas Be 100 Slot left margin ici lem punt eae wes 98 blot left paddingic i cer RR Ed 103 Slot linewidth siecia ahi obese 101 110 S
77. e 19 Lisp file Direct superclasses container page 99 class Direct methods e initialize instance e initialize instance e potential pack p page 84 method e help spec page 77 method e clon options group page 72 method e potential pack page 84 method e negated pack page 81 method e short pack page 87 method e postfix page 83 method Direct slots postfix Slot A postfix to the program synopsis Type or null string Initargs postfix Readers postfix page 83 generic function 114 The Clon Reference Manual short pack The short pack string Type or null string Readers short pack page 86 generic function negated pack The negated pack string Type or null string Readers negated pack page 81 generic function potential pack The potential pack string Type or null string Readers potential pack page 83 generic function clon options group The Clon options group Type net didierverna clon group Initargs clon options group Readers clon options group page 72 generic function text The TEXT class This class implements plain text objects appearing in a synopsis Package net didierverna clon page 27 Source text page 13 Lisp file Direct superclasses item page 106 class Direct methods e check name clash page 72 method e check name clash page 72 method e help spec page 77 method e untraverse page 90 metho
78. e 27 Source context page 23 Lisp file restartable check VALUED OPTION VALUE Function Restartably check that VALUE is valid for VALUED OPTION The only restart available use value offers to try a different value from the one that was provided Package net didierverna clon page 27 Source valued page 14 Lisp file restartable cmdline convert VALUED OPTION CMDLINE NAME Function CMDLINE ARGUMENT Restartably convert CMDLINE ARGUMENT to VALUED OPTION s value This function is used when the conversion comes from a command line usage of VALUED OPTION called by CMDLINE NAME As well as conversion errors this function might raise a missing cmdline argument error if CMDLINE ARGUMENT is nil and an argument is required Available restarts are depending on the context use fallback value return FALLBACK VALUE use default value return VALUED OPTION s default value use value return another already converted value use argument return the conversion of another argument Return two values VALUED OPTION s value and the actual value source The value source may be cmdline fallback or default Package net didierverna clon page 27 Source cmdline page 18 Lisp file restartable cmdline junk error JUNK Function Package net didierverna clon page 27 Source context page 23 Lisp file Chapter 6 Definitions 67 restartable convert VALUED OPTION ARGUMENT Function Restartably convert ARGUME
79. e 47 Function make xSW tCh oo o o oooooooooo 48 Function mnatch option eese 62 Appendix A Indexes Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi on Function Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi Functi on on on on on on on on on on on on on on on on on on on on on on on on on on on on on on on on on on on on on on on on on on on on on on nickname package 005 48 Open line t eue bee See 62 open next line sess 62 open sface 1 2 siste gv LIS 62 option abbreviation distance 62 option call pz 2i 9 epi REPAS en 62 parent generation 63 pathname component null p 63 pop frane seleri wu DR RAEICLe8 E 63 potential pack char 63 princ ceHarc sh eat Gate chs Ver 63 princ highlight property instances sbUES i ida 63 princ spaces ih eiie ERES 63 princ stringed arino mag EPRS 63 print error i vx da end 64 print faced help spec 64 A eek adele 64 p
80. e 74 method e check page 71 method e stringify page 88 method Direct slots argument name Slot Initform type enum base Class The ENUM BASE abstract class This class provides support for options including enumerated values Package net didierverna clon page 27 Source enum base page 17 Lisp file Direct superclasses standard object Direct subclasses e enun page 102 class e xswitch page 116 class Direct methods e initialize instance e enun page 75 method Direct slots enum Slot The set of possible values Initargs enum Readers enum page 75 generic function face Class The FACE class Package net didierverna clon page 27 Source face page 20 Lisp file Chapter 6 Definitions 103 Direct superclasses standard object Direct subclasses sface page 110 class Direct methods Direct slots e initialize instance e initialize instance e initialize instance e slot unbound e parent page 83 method e subfaces page 89 method e background page 71 method e foreground page 76 method e framedp page 76 method e crossed out p page 75 method e concealedp page 74 method e inversep page 79 method e blink page 71 method e underline page 90 method e italicp page 79 method e intensity page 78 method e item separator page 79 method e bottom padding page 71 method
81. e enun page 45 function e make flag page 45 function e make group page 45 function e make lispobj page 45 function e make path page 46 function e make stropt page 46 function e make switch page 47 function e make synopsis page 47 function e make text page 47 function e make xswitch page 48 function e multiple value getopt cmdline page 43 macro e nickname packagel page 48 function e progname page 48 function e remainder page 48 function e with context page 43 macro Internal Definitions e defgroup page 50 macro 28 The Clon Reference Manual executablep page 49 special variable highlight properties page 50 special variable item names page 50 special variable readtable page 50 special variable tiocgwinsz page 49 constant abstract class page 99 class accumulate page 50 macro add subface page 52 function allocate winsize page 53 function argument page 70 generic function argument page 70 method argument page 70 method argument page 70 method argument name page 70 generic function argument name page 70 method argument popable p page 53 function argument required p page 70 generic function argument required p page 70 method argument style page 70 generic function argument style page 70 method argument styles page 70 generic function argument styles page
82. e highlight property value 56 fallback value ees sacs yi X ge ha ha esas S 76 Tind stan iria a rd 56 flush sheetic is risas pel Vee Sees SU 56 foreground tag vores ee a Ee rid 76 frame left margin ccc eee 56 FAM HP esos Lee et essai eet ethene eat EIS 56 frame right margin 00 cece eee eee 56 frame sface nina pedo 56 framedp i e Ud A ELEC 76 TIMO asada 76 free winsiZze 1 0p io le 57 Function Version eee eee eee eee 52 Function setf cmdline option name 54 Function setf cmdline option option 54 Function setf cmdline option source 54 Function setf cmdline option value 54 Function setf frame left margin 56 Function setf frame right margin 56 Function setf frame sface s 56 Function setf highlight frame highlight property instances 0000 57 Function setf highlight frame left margin A A is oe teamed aes y 57 Function setf highlight frame right margin T un A hour RA 57 Function setf highlight frame sface 57 Function setf highlight property instance name 58 Function setf highlight property instance value 58 Function setf winsize ws col 69 Function setf winsize ws row 69 Function setf winsize ws xpixel 69 Function setf winsize ws ypixel 70 Function add subfa
83. e right margin page 67 function search branch page 67 function search face page 68 function search option page 68 function search option by abbreviation page 68 function Chapter 5 Packages 37 search option by name page 68 function search path page 86 generic function search path page 86 method search sticky option page 68 function select keys page 69 function sface page 110 class sface tree page 86 generic function sface tree page 86 method sheet page 110 class short call page 86 generic function short call page 86 method short name page 86 generic function short name page 86 method short pack page 86 generic function short pack page 87 method short pack page 87 method short pack char page 87 generic function short pack char page 87 method short pack char page 87 method short syntax help spec prefix page 87 generic function short syntax help spec prefix page 87 method short syntax help spec prefix page 87 method sibling page 87 generic function sibling page 87 method size of winsize page 49 constant split path page 69 function spurious cmdline argument page 96 condition stream ioctl output handle page 87 generic function method method method stream ioctl output handle page 88 stream ioctl output handle page 88 stream ioctl output handle page 88
84. eck name clash page 72 method e check name clash page 72 method e description page 75 method e env var page 75 method e help spec page 77 method e long name page 80 method e match option page 62 function e negated pack char page 81 generic function e negated pack char page 82 method e option page 108 class e option abbreviation distance page 62 function e option error page 95 condition 14 The Clon Reference Manual e option sticky distance page 82 generic function e option sticky distance page 83 method e potential pack char page 63 function e short name page 86 method e short pack char page 87 generic function e short pack char page 87 method e untraverse page 90 method 4 1 12 core src options flag lisp Dependency option page 13 Lisp file Parent options page 9 module Location core src options flag lisp Exported Definitions nake flag page 45 function Internal Definitions e flag page 106 class e make internal flag page 59 function 4 1 13 core src options valued lisp Dependency option page 13 Lisp file Parent options page 9 module Location core src options valued lisp Internal Definitions e item names page 50 special variable e argument name page 70 method e argument required p page 70 method e check page 71 generic function e convert page 74 generi
85. el a Goes 50 add subface gio v 6RrIb 4er h unnn ET onae E 52 allocate winsize neutroari a ee pinea eee ee 53 argume t ww Anil A URN Rs 70 argument name 2sdiscliexiil l4 hones bev es 70 argument popable p eee cece eee 53 argument required p cece eee eee eee 70 argument style isses ucl sig lg pn e 70 argument styles cece eee 70 attach face tree eee eee 53 available right margin 0000 53 B background bend laa is IP 71 beginning of string p cece eee eee 53 AE AAA eure IxemoDa eme Xam aei S uta 71 bottom padding eee 71 C Check oo suus pU Ree OR UERISEREUEROE NOE 71 72 check name clash oooocccococccccccccccccc o 72 CLIO a RU RETE 53 clon options group sse eee eee 72 CLOSE AMO a Dig ated pate 73 119 A sii once AER teeta eats 53 C1086 SfaCG iv aed ePDgRRORRG X ECURPUEPEDRE RE 53 closest matCh cz obi Ele Nba 54 cmdline niapi o as La ed US 43 cmdline converts iii 54 cmdline option NaMO oooocococccccccccccccccco 54 cmdline option option 0 eee eee 54 cmdline opti j p ainesse ia lea Ru 54 cmdline option source lesse 54 cmdline option value sse 54 emdline options cio bees cs e 73 cmdline options pe pia a E Li eb 43 cmdline pir Soe iat Dee cs oa lat Det 43 COLUMN ES 73 COMO as ai e 73 complete String oeiee siini p eee eee 54 CONCA Pi ee bs eats 73 74 configurati o areri nenn
86. en HELP SPEC s face and print all of its items with it retrieve from environment OPTION ENV VAL Generic Function Retrieve OPTION s value from the environment ENV VAL is the value stored in the associated environment variable Package net didierverna clon page 27 Source environ page 19 Lisp file Methods retrieve from environment OPTION ENV VAL before Method Assert that ENV VAL is not null retrieve from environment FLAG flag ENV VAL Method retrieve from environment OPTION valued option Method ENV VAL Chapter 6 Definitions 85 retrieve from long call OPTION CMDLINE NAME amp optional Generic Function CMDLINE ARGUMENT CMDLINE Retrieve OPTION s value from a long call CMDLINE NAME is the name used on the command line CMDLINE ARGUMENT is a potentially already parsed cmdline argument Otherwise CMDLINE is where to find an argument This function returns three values the retrieved value the value source the new command line possibly with the first item popped if the option requires an argu ment Package net didierverna clon page 27 Source cmdline page 18 Lisp file Methods retrieve from long call OPTION option Method CMDLINE NAME amp optional CMDLINE ARGUMENT CMDLINE retrieve from long call OPTION valued option Method CMDLINE NAME amp optional CMDLINE ARGUMENT CMDLINE retrieve from negated call OPTION Generic Function Retrieve OPTION s value from a negated call Package ne
87. ent S ace ooooccoccccccccccccco 55 Function directory pathname p 55 Function environment convert 55 Punction ekite it cu E UNA PTUSY 44 Function exit abnormally sess 56 Function face highlight property set p 56 Function face highlight property value 56 Function find sface 2 ee eee eee eee 56 Function flush sheet 0 cesses 56 Function frame left margin 56 Function frame p 4 0 ld rr ses 56 Function frame right margin 56 Function frame sface ee eee eee 56 Function free winsize 000 5T Function get top padding sess 57 Function getenv ccce 57 Function getopt c ll2 a DR TY iere 44 Function getopt cmdline esses 44 Function help eem ir e EEN 44 Function help spec items will print 97 Function highlight frame highlight property INSTANCES ees set Cates mci WbnREDERGG ped 97 Function highlight frame left margin 57 Function highlight frame p 57 Function highlight frame right margin 57 Function highlight frame sface 57 Function highlight property instance escape Sequence x esc Soe e cute ed audi 97 Function highlight property instance name 58 Function highlight property instance p 58 Function highlight property instance value AN O tool cmo ico
88. enum base Method The set of possible values Source enum base page 17 Lisp file env val CONDITION Generic Function Package net didierverna clon page 27 Methods env val CONDITION invalid environment value Method env var OBJECT Generic Function Package net didierverna clon page 27 Methods env var CONDITION environment error Method env var OPTION option Method The option s associated environment variable Source option page 13 Lisp file 76 The Clon Reference Manual error handler OBJECT Package Methods net didierverna clon page 27 error handler CONTEXT context The behavior to adopt on option retrieval errors Source context page 23 Lisp file error string CONDITION setf error string NEW VALUE CONDITION Package Methods net didierverna clon page 27 error string CONDITION home directory setf error string NEW VALUE CONDITION home directory fallback value OBJECT Package Methods net didierverna clon page 27 fallback value VALUED OPTION valued option The option s fallback value Source valued page 14 Lisp file foreground OBJECT Package Methods net didierverna clon page 27 foreground FACE face The face foreground Source face page 20 Lisp file framedp OBJECT Package Methods net didierverna clon page 27 framedp FACE face The face s framed status Source face page 20 Lisp file frames OBJECT se
89. env val page 75 method Direct slots argument The invalid environment variable value Initargs env val argument Readers env val page 75 generic function invalid negated equal syntax An error related to a negated equal syntax Package net didierverna clon page 27 Source context page 23 Lisp file Direct superclasses cmdline error page 91 condition invalid negated syntax An invalid negated syntax error Package net didierverna clon page 27 Source cmdline page 18 Lisp file Direct superclasses cmdline option error page 92 condition Slot Condition Condition Slot Condition Condition Chapter 6 Definitions invalid short equal syntax An error related to a short equal syntax Package net didierverna clon page 27 Source context page 23 Lisp file Direct superclasses cmdline error page 91 condition invalid value An invalid value error Package net didierverna clon page 27 Source valued page 14 Lisp file Direct superclasses option error page 95 condition Direct methods e comment page 73 method e value page 90 method Direct slots value The invalid value Initargs value Readers value page 90 generic function comment An additional comment about the error Initargs comment Readers comment page 73 generic function missing cmdline argument A missing command line argument error Package n
90. et didierverna clon page 27 Source cmdline page 18 Lisp file Direct superclasses cmdline option error page 92 condition option error An error related to an option Package net didierverna clon page 27 Source option page 13 Lisp file Direct superclasses error Direct subclasses e invalid value page 95 condition e invalid argument page 93 condition e cmdline option error page 92 condition 95 Condition Condition Slot Slot Condition Condition 96 The Clon Reference Manual e environmental option error page 93 condition Direct methods option page 82 method Direct slots option Slot The concerned option Initargs option Readers option page 82 generic function spurious cmdline argument Condition A spurious command line argument error Package net didierverna clon page 27 Source cmdline page 18 Lisp file Direct superclasses cmdline option error page 92 condition Direct methods argument page 70 method Direct slots argument Slot The spurious argument Initargs argument Readers argument page 70 generic function unknown cmdline option error Condition An error related to an unknown command line option Package net didierverna clon page 27 Source context page 23 Lisp file Direct superclasses cmdline error page 91 condition Direct methods e argument page 70 method e name
91. et didierverna clon page 27 Source neta page 11 Lisp file list to string LIST amp key KEY SEPARATOR Return a SEPARATOR separated string of all LIST elements KEY should provide a way to get a string from each LIST element SEPARATOR is the string to insert between elements Package net didierverna clon page 27 Source util page 12 Lisp file macosp Return t if running on Mac OS Package net didierverna clon page 27 Source util page 12 Lisp file make cmdline option amp key NAME NAME OPTION OPTION VALUE VALUE SOURCE SOURCE Package net didierverna clon page 27 Source context page 23 Lisp file make frame amp key SFACE SFACE LEFT MARGIN LEFT MARGIN RIGHT MARGIN RIGHT MARGIN Package net didierverna clon page 27 Source sheet page 21 Lisp file Function Function Function Function Function Chapter 6 Definitions 59 make highlight frame amp key SFACE SFACE LEFT MARGIN Function LEFT MARGIN RIGHT MARGIN RIGHT MARGIN HIGHLIGHT PROPERTY INSTANCES HIGHLIGHT PROPERTY INSTANCES Package net didierverna clon page 27 Source sheet page 21 Lisp file make highlight property instance amp key NAME NAME VALUE Function VALUE Package net didierverna clon page 27 Source sheet page 21 Lisp file make internal enum LONG NAME DESCRIPTION amp rest KEYS amp key Function ARGUMENT NAME ARGUMENT TYPE ENUM ENV VAR FALLBACK VALUE
92. f yes values page 91 method 4 1 16 core src options switch lisp Dependency switch base page 15 Lisp file Parent options page 9 module Location core src options switch lisp Exported Definitions make switch page 47 function Internal Definitions e check page 72 method e convert page 74 method e make internal switch page 61 function e stringify page 88 method e switch page 111 class 16 The Clon Reference Manual 4 1 17 core src options stropt lisp Dependency valued page 14 Lisp file Parent options page 9 module Location core src options stropt lisp Exported Definitions make stropt page 46 function Internal Definitions e check page 72 method e convert page 74 method e make internal stropt page 60 function e stringify page 88 method e stropt page 111 class 4 1 18 core src options lispobj lisp Dependency valued page 14 Lisp file Parent options page 9 module Location core src options lispobj lisp Exported Definitions nake lispobj page 45 function Internal Definitions e check page 71 method e convert page 74 method e lispobj page 107 class e make internal lispobj page 59 function e stringify page 88 method e typespec page 90 method 4 1 19 core src options path lisp Dependency valued page 14 Lisp file Parent options page 9 module Location core src opt
93. flush sheet page 56 function frame page 98 structure frame left margin page 56 function setf frame left margin page 56 function frame p page 56 function frame right margin page 56 function setf frame right margin page 56 function frame sface page 56 function setf frame sface page 56 function frames page 76 method setf frames page 76 method get bottom padding page 77 generic function 22 The Clon Reference Manual get bottom padding page 77 method get bottom padding page 77 method get top padding page 57 function help spec items will print page 57 function help spec will print page 78 generic function help spec will print page 78 method help spec will print page 78 method help spec will print page 78 method highlight frame page 98 structure highlight frame highlight property instances page 57 function setf highlight frame highlight property instances page 57 func tion highlight frame left margin page 57 function setf highlight frame left margin page 57 function highlight frame p page 57 function highlight frame right margin page 57 function setf highlight frame right margin page 57 function highlight frame sface page 57 function setf highlight frame sface page 57 function highlight property ecase page 51 macro highlight property instance page 99 structure highlight property instance escape
94. g on tty s through ISO IEC 6429 SGR This formatting is customizable through themes Depending on the target audience Clon stands for either The Command Line Options Nuker or The Common Lisp Options Nuker Clon also has a recursive acronym Clon Likes Options Nuking and a reverse one Never Omit to Link with Clon Other possible expansions of the acronym are still being investigated This is the Clon reference manual and as such it is not meant to be read It may help you find sleep in case of insomnia though Clon comes with two human readable manuals e the end user manual see The Clon End User Manual is for the Clon end user that is the user of an application powered by Clon It describes how to use the command line of clonified applications and how to customize Clon s output Everybody should read this manual first e the user manual see The Clon End User Manual is for the Clon user that is the developer of a Common Lisp application who wants to use Clon for command line option management It describes how to clonify your application and extend the library with your own option types l An application using Clon for its command line option management is said to be clonified It is also possible to say clonfiscated However we advise against using clonistified The term clonificated is also considered bad style and the use of clonificationated is strictly prohibited Chapter 2 Systems 5
95. ge net didierverna clon page 27 Source context page 23 Lisp file search option by abbreviation CONTEXT PARTIAL NAME Function Search for option abbreviated with PARTIAL NAME in CONTEXT When such an option exists return two values the option itself the completed name Package net didierverna clon page 27 Source context page 23 Lisp file search option by name CONTEXT amp rest KEYS amp key SHORT NAME Function LONG NAME Search for option with either SHORT NAME or LONG NAME in CONTEXT When such an option exists return two values the option itself the name that matched Package net didierverna clon page 27 Source context page 23 Lisp file search sticky option CONTEXT NAMEARG Function Search for a sticky option in CONTEXT matching NAMEARG NAMEARG is the concatenation of the option s short name and its argument In case of multiple matches the option with the longest name is selected When such an option exists return two values the option itself the argument part of NAMEARG Package net didierverna clon page 27 Source context page 23 Lisp file Chapter 6 Definitions 69 select keys KEYS amp rest SELECTED Function Return a new property list from KEYS with only SELECTED ones Package net didierverna clon page 27 Source util page 12 Lisp file split path PATH Function Split PATH into a list of directories Package net didierverna clon page
96. ge 106 class 100 The Clon Reference Manual Direct subclasses e e Direct methods e e Direct slots group page 106 class synopsis page 113 class napoptions page 81 method initialize instance initialize instance help spec page 77 method check name clash page 72 method check name clash page 72 method check name clash page 72 method untraverse page 90 method items page 79 method items Slot The items in the container Type list Initargs items Readers items page 79 generic function context Class The CONTEXT class This class represents the associatiion of a synopsis and a set of command line options based on it Package net didierverna clon page 27 Source context page 23 Lisp file Direct superclasses standard object Direct methods initialize instance untraverse page 90 method mapoptions page 81 method potential pack p page 84 method clon options group page 72 method negated pack page 81 method short pack page 87 method postfix page 83 method error handler page 76 method highlight page 78 method line width page 80 method theme page 89 method search path page 86 method cmdline options Chapter 6 Definitions e cmdline options page 73 method e synopsis page 89 method Direct slots synopsis The program synopsis Type net didierverna clon synopsis Initargs
97. ge 27 Source context page 23 Lisp file dump NAME FUNCTION amp rest ARGS Macro Dump a standalone executable named NAME starting with FUNCTION ARGS may be any arguments understood by the underlying implementation s dumping facil ity T hey will simply be passed along Note that DUMP already passes some such arguments Some of them are critical for the dumping facility e g executable and cannot be overrid den Some others however will be if you provide them as well e g load init file Since executable dumping is not available in all supported implementations this function behaves differently in some cases as described below ECL doesn t create executables by dumping a Lisp image but relies on having toplevel code to execute instead so this macro simply expands to a call to FUNCTION This also means Chapter 6 Definitions 43 that ARGS is unused ABCL can t dump executables at all because of the underlying Java implementation so this macro expands to just PROGN but creates a Java class file with a main function that creates an interpreter loads the file in which this macro call appears and calls FUNCTION This also means that ARGS is unused Package net didierverna clon page 27 Source util page 12 Lisp file multiple value getopt cmdline OPTION NAME VALUE SOURCE amp key Macro CONTEXT amp body BODY Get the next command line option in CONTEXT and evaluate BODY OPTION NAME and VALUE are bound
98. h column page 64 function read sface tree page 65 function safe left margin page 67 function safe right margin page 67 function sface page 110 class sface tree page 86 method sheet page 110 class sibling page 87 method top padding page 89 method top padding page 89 method try read sface tree page 69 function try read theme page 69 function 4 1 30 core src context lisp Dependency output page 10 module Parent Location src page 9 module core src context lisp Exported Definitions context page 41 special variable cmdline options p page 43 function cmdline p page 43 function do cmdline options page 42 macro getopt page 44 function getopt cmdline page 44 function help page 44 function make context page 44 function multiple value getopt cmdline page 43 macro progname page 48 function 24 The Clon Reference Manual remainder page 48 function with context page 43 macro Internal Definitions clon options group page 72 method cmdline junk error page 91 condition cmdline option page 97 structure cmdline option name page 54 function setf cmdline option name page 54 function cmdline option option page 54 function setf cmdline option option page 54 function cmdline option p page 54 function cmdline option source page 54 function setf cmdline option source
99. hen HIDDEN the option doesn t appear in help strings Chapter 6 Definitions 61 Package net didierverna clon page 27 Source stropt page 16 Lisp file make internal switch LONG NAME DESCRIPTION amp rest KEYS amp key Function ARGUMENT STYLE ARGUMENT TYPE ENV VAR DEFAULT VALUE HIDDEN Make a new internal Clon specific switch LONG NAME is the switch s long name sans the clon prefix Internal options don t have short names DESCRIPTION is the switch s description ARGUMENT STYLE is the switch s argument display style It can be one of yes no on off true false yup nope or yeah nah It defaults to yes no ARGUMENT TYPE is one of required mandatory or optional required and mandatory are synonyms It defaults to optional ENV VAR is the switch s associated environment variable sans the CLON_ prefix It defaults to nil DEFAULT VALUE is the switch s default value if any When HIDDEN the option doesn t appear in help strings Package net didierverna clon page 27 Source switch page 15 Lisp file make internal text amp rest KEYS amp key CONTENTS HIDDEN Function Package net didierverna clon page 27 Source text page 13 Lisp file make internal xswitch LONG NAME DESCRIPTION amp rest KEYS amp key Function ARGUMENT NAME ARGUMENT TYPE ENUM ENV VAR DEFAULT VALUE HIDDEN Make a new internal Clon specific xswitch LONG NAME is the xswitch
100. icp page 79 method item separator page 79 method left padding page 80 method make face tree page 80 generic function make face tree page 80 method make face tree page 80 method make raw face tree page 61 function name page 81 method parent page 83 method parent generation page 63 function right padding page 86 method search branch page 67 function Chapter 4 Files 21 search face page 68 function subface page 88 generic function subface page 88 method subface page 88 method subfaces page 89 method top padding page 89 method underline page 90 method visiblep page 91 method 4 1 29 core src output sheet lisp Dependency face page 20 Lisp file Parent output page 10 module Location core src output sheet lisp Internal Definitions available right margin page 53 function close frame page 73 generic function close frame page 73 method close frame page 73 method close line page 53 function close sface page 53 function column page 73 method setf column page 73 method copy frame page 55 function copy highlight frame page 55 function copy highlight property instance page 55 function current frame page 55 function current left margin page 55 function current right margin page 55 function current sface page 55 function find sface page 56 function
101. ight by the corresponding string length so control characters as well as newlines and tabs are forbidden here Package net didierverna clon page 27 Source sheet page 21 Lisp file 64 The Clon Reference Manual print error ERROR amp optional INTERACTIVEP amp aux STREAM Function PRINT ESCAPE Print ERROR on ERROR OUTPUT When INTERACTIVEP print on QUERY IO instead Package net didierverna clon page 27 Source context page 23 Lisp file print faced help spec SHEET SFACE ITEMS Function Print all help specification ITEMS on SHEET with SFACE Package net didierverna clon page 27 Source sheet page 21 Lisp file print help SHEET HELP Function Open the toplevel help face and print HELP on SHEET with it Package net didierverna clon page 27 Source sheet page 21 Lisp file print string SHEET STRING Function Output STRING to SHEET STRING is output within the current frame s bounds Spacing characters are honored but newlines might replace spaces when the output reaches the rightmost bound Package net didierverna clon page 27 Source sheet page 21 Lisp file push frame SHEET FRAME Function Push a new frame to SHEET s frames Package net didierverna clon page 27 Source sheet page 21 Lisp file putenv VARIABLE VALUE Function Set environment VARIABLE to VALUE Package net didierverna clon page 27 Source util page 12 Lisp file reach column SHEET CO
102. ing Slot The face top padding This property can take the following forms nil the output can start right away 0 the output should start on the next line N gt 0 there should be N empty lines before the output Initargs padding top Readers top padding page 89 generic function bottom padding Slot The face bottom padding This property can take the following forms nil the next output can start right at the end of this face s 0 the next output should start on the next line N gt 0 there should be N empty lines before the next output Initargs padding bottom Readers bottom padding page 71 generic function item separator Slot The face item separator Initargs item separator Initform Readers item separator page 79 generic function intensity Slot The face intensity Initargs intensity Readers intensity page 78 generic function Chapter 6 Definitions italicp The face s italic status Initargs italic Readers italicp page 79 generic function underline The face s underline level Initargs underline Readers underline page 90 generic function blink The face s blink speed Initargs blink Readers blink page 71 generic function inversep The face s inverse video status Initargs inverse Readers inversep page 79 generic function concealedp The face s concealed status Initargs concealed Readers co
103. ion argument required p Slot Whether the option s argument is required Readers argument required p page 70 generic function fallback value Slot The option s fallback value Initargs fallback value Readers fallback value page 76 generic function 116 The Clon Reference Manual default value Slot The option s default value Initargs default value Readers default value page 75 generic function Direct Default Initargs Initarg Value argument type required xswitch Class The XSWITCH class This class merges the functionalities of switches and enumerations As such the negated syntax is available for extended xswitches Package net didierverna clon page 27 Source xswitch page 17 Lisp file Direct superclasses e valued option page 114 class e enum base page 102 class e switch base page 112 class Direct methods e convert page 74 method e check page 71 method e stringify page 88 method Direct slots enum Slot The set of possible non boolean values Appendix A Indexes 117 Appendix A Indexes 118 A 1 Concepts C core met lisp vos seni e eee uba eee epee COLe SEC E We Mes y Seeds core src container lisp esses core src context lisp cee eee eee eee eee core src group lisp sess core src item lisp i e necios core src options cummins core src options enum base lisp core
104. ions path lisp Exported Definitions nake path page 46 function Internal Definitions e check page 71 method e convert page 74 method e directory pathname p page 55 function e make internal path page 60 function e path page 109 class Chapter 4 Files 17 path type page 83 method e pathname component null p page 63 function e split path page 69 function stringify page 88 method 4 1 20 core src options enum base lisp Parent options page 9 module Location core src options enum base lisp Internal Definitions e enun page 75 method e enum base page 102 class 4 1 21 core src options enum lisp Dependencies e valued page 14 Lisp file e enum base page 17 Lisp file Parent options page 9 module Location core src options enum lisp Exported Definitions nake enum page 45 function Internal Definitions e check page 71 method e convert page 74 method e enum page 102 class e make internal enum page 59 function e stringify page 88 method 4 1 22 core src options xswitch lisp Dependencies e valued page 14 Lisp file e switch base page 15 Lisp file e enum base page 17 Lisp file Parent options page 9 module Location core src options xswitch lisp Exported Definitions nake xswitch page 48 function Internal Definitions e check page 71 method e convert page 74 method e m
105. irect methods e error string e error string page 76 method Direct slots error string Slot Initargs error string Readers error string page 76 generic function Writers setf error string page 76 generic function invalid argument Condition An invalid argument error Package net didierverna clon page 27 Source valued page 14 Lisp file Direct superclasses option error page 95 condition Direct subclasses e invalid cmdline argument page 94 condition e invalid environment value page 94 condition Direct methods e comment page 73 method e argument page 70 method Direct slots argument Slot The invalid argument Initargs argument Readers argument page 70 generic function 94 The Clon Reference Manual comment An additional comment about the error Initargs comment Readers comment page 73 generic function invalid cmdline argument An invalid command line argument error Package net didierverna clon page 27 Source cmdline page 18 Lisp file Direct superclasses e invalid argument page 93 condition e cmdline option error page 92 condition invalid environment value An invalid environment variable s value error Package net didierverna clon page 27 Source environ page 19 Lisp file Direct superclasses e invalid argument page 93 condition e environmental option error page 93 condition Direct methods
106. l ARGUMENT NAME is the option s argument name appearing in help strings ARGUMENT TYPE is one of required mandatory or optional required and mandatory are synonyms It defaults to optional ENUM is the set of possible non boolean values ENV VAR is the xswitch s associated environment variable It defaults to nil DEFAULT VALUE is the xswitch s default value if any When HIDDEN the option doesn t appear in help strings Package net didierverna clon page 27 Source xswitch page 17 Lisp file nickname package amp optional NICKNAME Function Add NICKNAME CLON by default to the NET DIDIERVERNA CLON package Package net didierverna clon page 27 Source meta page 11 Lisp file progname amp key CONTEXT Function Return CONTEXT s program name Package net didierverna clon page 27 Source context page 23 Lisp file remainder amp key CONTEXT Function Return CONTEXT s remainder Package net didierverna clon page 27 Source context page 23 Lisp file setup termio Function Autodetect termio support Update Clon configuration and FEATURES accordingly Package net didierverna clon setup page 39 Source setup page 25 Lisp file version amp optional TYPE Function Return the current version of Clon TYPE can be one of number short or long A version number is computed as major 10000 minor 100 patchlevel leaving two digits for each level Alpha be
107. l variable configuration page 43 function configure page 44 function setup termio page 48 function version page 48 function Internal Definitions version page 52 function release status number page 65 function restrict because page 67 function Chapter 6 Definitions 6 Definitions 41 Definitions are sorted by export status category package and then by lexicographic order 6 1 Exported definitions 6 1 1 Special variables context The current context Package net didierverna clon page 27 Source context page 23 Lisp file release major level The major level of this release Package net didierverna clon setup page 39 Source setup page 25 Lisp file release minor level The minor level of this release Package net didierverna clon setup page 39 Source setup page 25 Lisp file release name The name of this release Package net didierverna clon setup page 39 Source setup page 25 Lisp file release status The status of this release Package net didierverna clon setup page 39 Source setup page 25 Lisp file release status level The status level of this release Package net didierverna clon setup page 39 Source setup page 25 Lisp file synopsis The current synopsis Package net didierverna clon page 27 Source synopsis page 19 Lisp file Special Variable Special Variable
108. lot long name 2 0 00 90 1 Edo 4 ferus 109 Slot ME rs bs 97 99 103 Slot negated pack 6 eee 114 Slot no values ocec2 55 vation an 113 Slot option EN 96 97 Slot output stream 008 110 blot parente rata dada 106 Slot path type sseni en u ae OE A AE DEA Sets 109 olot postil i oh rebre a S RR n dades 113 Slot potential pack 0 2008 114 127 Slot prognatie goes c g cai ia 101 Slot TEMA 101 Slot right margines sogner ra e a 98 Slot right padding oooooccoccoccnccncooo 104 Slot search path 000 eee 101 Slot Sfate s s ves age puse Mies ates Redit 98 plot sface treel sie aie ee hte es dee a i 111 Slot Sshort name casar 3 eR pe 108 Slot sho rt packiscevelb el iR EM YII 114 Slot si ti f er prr 110 Slot so rce el IRI RR e EI YT ELT 98 Slot subfaces i i ll c2 x ll dac Re E os 106 Slot SyHOPS1S cose eed eer THREE ER 101 Slot theme iio bici 101 Slot top padding 00 e eee 104 Slot traversedp i oov DU RMEEMP EGIT 107 Slot typespec s ore e EE E 107 Slot underline cee ee eee eee 105 Slot valts eseou cea eee eb x ees ira 95 98 99 Slot visiblep ii 208 e Best A hw dt 103 Slot yes VALUES si E Me ine needs ees 112 SOULCE a EN pR DETUR he ES 98 Special Variable context sssees 41 Special Variable executablep 49 Special Variable highlight pro
109. lt value if any When HIDDEN the option doesn t appear in help strings Package net didierverna clon page 27 Source lispobj page 16 Lisp file make path amp rest KEYS amp key SHORT NAME LONG NAME Function DESCRIPTION ARGUMENT NAME ARGUMENT TYPE ENV VAR FALLBACK VALUE DEFAULT VALUE TYPE HIDDEN Make a new path option SHORT NAME is the option s short name without the dash It defaults to nil LONG NAME is the option s long name without the double dash It defaults to nil DESCRIPTION is the option s description appearing in help strings It defaults to nil ARGUMENT NAME is the option s argument name appearing in help strings ARGUMENT TYPE is one of required mandatory or optional required and mandatory are synonyms It defaults to optional ENV VAR is the option s associated environment variable It defaults to nil FALLBACK VALUE is the option s fallback value for missing optional arguments if any DEFAULT VALUE is the option s default value if any TYPE is the pathname type It can be one of file directory file list directory list or nil meaning that everything is allowed When HIDDEN the option doesn t appear in help strings Package net didierverna clon page 27 Source path page 16 Lisp file make stropt amp rest KEYS amp key SHORT NAME LONG NAME Function DESCRIPTION ARGUMENT NAME ARGUMENT TYPE ENV VAR FALLBACK VALUE DEFAULT V
110. method IO i stream ioctl output handle page 88 stream line width page 69 function stringify page 88 generic function stringify page 88 method stringify page 88 stringify page 88 stringify page 88 stringify page 88 stringify page 88 method stropt page 111 class subface page 88 generic function subface page 88 method 38 The Clon Reference Manual subface page 88 method subfaces page 89 generic function subfaces page 89 method switch page 111 class switch base page 112 class synopsis page 89 generic function synopsis page 89 method synopsis page 113 class text page 114 class theme page 89 generic function theme page 89 method tilde reader page 69 function top padding page 89 generic function top padding page 89 method top padding page 89 method top padding page 89 method traversedp page 89 generic function traversedp page 89 method setf traversedp page 89 method setf traversedp page 89 generic function try read sface tree page 69 function try read theme page 69 function typespec page 90 generic function typespec page 90 method underline page 90 generic function underline page 90 method unknown cmdline option error page 96 condition unrecognized negated call error page 97 condition unrecognized short call error page 97 condition untraver
111. n e line width page 80 method e line width page 80 method e lispobj page 107 class e list to string page 58 function e long name page 80 generic function e long name page 80 method e macosp page 58 function e make cmdline option page 58 function e make face tree page 80 generic function e make face tree page 80 method e make face tree page 80 method e make frame page 58 function e nake highlight frame page 59 function e nake highlight property instance page 59 function e make internal enun page 59 function e make internal flag page 59 function e make internal lispobj page 59 function e make internal path page 60 function e nake internal stropt page 60 function 34 The Clon Reference Manual make internal switch page 61 function make internal text page 61 function make internal xswitch page 61 function make raw face tree page 61 function make raw sface page 62 function make sheet page 62 function map frames page 51 macro mapoptions page 80 generic function mapoptions page 81 method mapoptions page 81 method mapoptions page 81 method mapoptions page 81 method mapoptions page 81 method match option page 62 function maybe pop argument page 51 macro maybe push page 52 macro missing cmdline argument page 95 condition name page 81 gene
112. ncealedp page 73 generic function crossed out p The face s crossed out status Initargs crossed out Readers crossed out p page 75 generic function framedp The face s framed status Initargs framed Readers framedp page 76 generic function foreground The face foreground Initargs foreground Readers foreground page 76 generic function background The face background Initargs background Readers background page 71 generic function 105 Slot Slot Slot Slot Slot Slot Slot Slot Slot 106 The Clon Reference Manual subfaces Slot The face children Initargs subfaces Readers subfaces page 89 generic function parent Slot The face parent Readers parent page 83 generic function flag Class The FLAG class This class implements options that don t take any argument Package net didierverna clon page 27 Source flag page 14 Lisp file Direct superclasses option page 108 class Direct methods retrieve from environment page 84 method group Class The GROUP class This class groups other groups options or strings together effectively implementing hierar chical program command line Package net didierverna clon page 27 Source group page 18 Lisp file Direct superclasses container page 99 class Direct methods e help spec page 77 method e header page 77 method Direct slots
113. nction read env val page 65 function read long name page 65 function read sface tree page 65 function read value page 65 function remove keys page 65 function replace in keys page 52 macro replace key page 65 function replace keys page 66 function restart on error page 66 function restartable check page 66 function restartable cmdline convert page 66 function restartable cmdline junk error page 66 function restartable convert page 67 function restartable environment convert page 67 function restartable invalid negated syntax error page 52 macro restartable spurious cmdline argument error page 52 macro retrieve from environment page 84 generic function retrieve from environment page 84 method retrieve from environment page 84 method retrieve from environment page 84 method retrieve from long call page 85 generic function retrieve from long call page 85 method retrieve from long call page 85 method retrieve from negated call page 85 generic function retrieve from negated call page 85 method retrieve from negated call page 85 method retrieve from negated call page 85 method retrieve from short call page 85 generic function retrieve from short call page 85 method retrieve from short call page 85 method right padding page 86 generic function right padding page 86 method safe left margin page 67 function saf
114. nction ARGUMENT NAME ARGUMENT TYPE ENV VAR TYPESPEC FALLBACK VALUE DEFAULT VALUE HIDDEN Make a new internal Clon specific string option LONG NAME is the option s long name sans the clon prefix Internal options don t have short names 60 The Clon Reference Manual DESCRIPTION is the options s description ARGUMENT NAME is the option s argument name appearing in help strings ARGUMENT TYPE is one of required mandatory or optional required and mandatory are synonyms It defaults to optional ENV VAR is the option s associated environment variable sans the CLON_ prefix It defaults to nil TYPESPEC is a type specifier the option s value should satisfy FALLBACK VALUE is the option s fallback value for missing optional arguments if any DEFAULT VALUE is the option s default value if any When HIDDEN the option doesn t appear in help strings Package net didierverna clon page 27 Source lispobj page 16 Lisp file make internal path LONG NAME DESCRIPTION amp rest KEYS amp key Function ARGUMENT NAME ARGUMENT TYPE ENV VAR FALLBACK VALUE DEFAULT VALUE TYPE HIDDEN Make a new internal Clon specific path option LONG NAME is the option s long name sans the clon prefix Internal options don t have short names DESCRIPTION is the options s description ARGUMENT NAME is the option s argument name appearing in help strings ARGUMENT TYPE is one of re
115. nternal Definitions e stream ioctl output handle page 87 generic function e stream ioctl output handle page 88 method e stream ioctl output handle page 88 method e stream ioctl output handle page 88 method e stream ioctl output handle page 88 method e stream line width page 69 function 4 1 7 core meta lisp Parent net didierverna clon core page 7 system Location core meta lisp Packages net didierverna clon page 27 Exported Definitions nickname package page 48 function Internal Definitions e readtable page 50 special variable 12 The Clon Reference Manual clindent page 53 function defindent page 50 macro i reader page 58 function in readtable page 51 macro tilde reader page 69 function 4 1 8 core src util lisp Parent src page 9 module Location core src util lisp Exported Definitions cmdline page 43 function dump page 42 macro exit page 44 function Internal Definitions executablep page 49 special variable abstract class page 99 class accumulate page 50 macro beginning of string p page 53 function closest match page 54 function complete string page 54 function copy instance page 74 generic function copy instance page 75 method declare valid superclass page 50 macro defabstract page 50 macro econd page 51 macro endpush page 51 macro getenv page
116. o a parent face named FACE NAME Source face page 20 Lisp file search path OBJECT Generic Function Package net didierverna clon page 27 Methods search path CONTEXT context Method The search path for Clon files Source context page 23 Lisp file sface tree OBJECT Generic Function Package net didierverna clon page 27 Methods sface tree SHEET sheet Method The sheet s sface tree Source sheet page 21 Lisp file short call CONDITION Generic Function Package net didierverna clon page 27 Methods short call CONDITION Method unrecognized short call error short name OBJECT Generic Function Package net didierverna clon page 27 Methods short name OPTION option Method The option s short name Source option page 13 Lisp file short pack OBJECT Generic Function Package net didierverna clon page 27 Methods Chapter 6 Definitions 87 short pack CONTEXT context Method Return the short pack of CONTEXT s synopsis Source context page 23 Lisp file short pack SYNOPSIS synopsis Method The short pack string Source synopsis page 19 Lisp file short pack char OPTION amp optional AS STRING Generic Function Return OPTION s short pack character if any If AS STRING return a string of that character Package net didierverna clon page 27 Source option page 13 Lisp file Methods short pack char OPTION valued option amp optional Method AS STRING
117. o nothing no name clash with a text object check name clash TEXT text ITEM2 Method Do nothing no name clash with a text object check name clash OPTIONI option OPTION2 option Method Ensure that there is no name clash between OPTION1 and OPTION2 clon options group OBJECT Generic Function Package net didierverna clon page 27 Methods clon options group CONTEXT context Method Return the Clon options group of CONTEXT s synopsis Source context page 23 Lisp file clon options group SYNOPSIS synopsis Method The Clon options group Source synopsis page 19 Lisp file Chapter 6 Definitions close frame SHEET FRAME Close FRAME on SHEET Package net didierverna clon page 27 Source sheet page 21 Lisp file Method Combination progn Options most specific last 73 Generic Function Methods close frame SHEET FRAME frame amp aux Method RIGHT MARGIN progn Reach FRAME s right margin if it has one close frame SHEET FRAME highlight frame progn Method Restore the upper frame s highlight properties cmdline options OBJECT setf cmdline options NEW VALUE OBJECT Package net didierverna clon page 27 Methods cmdline options CONTEXT context setf cmdline options NEW VALUE CONTEXT context The options from the command line Source context page 23 Lisp file column OBJECT setf column NEW VALUE OBJECT Package net didierverna clon page 27 Methods column
118. od e parent page 83 generic function e parent page 83 method e parent generation page 63 function e path page 109 class e path type page 83 generic function e path typel page 83 method e pathname component null p page 63 function e pop frame page 63 function e postfix page 83 generic function e postfix page 83 method e postfix page 83 method e potential pack page 83 generic function e potential pack page 84 method e potential pack char page 63 function e potential pack p page 84 generic function e potential pack p page 84 method e potential pack p page 84 method e princ char page 63 function e princ highlight property instances page 63 function e princ spaces page 63 function e princ string page 63 function e print error page 64 function e print faced help spec page 64 function e print help page 64 function e print help spec page 84 generic function method method method method e print help spec page 84 method e print help spec page 84 e print help spec page 84 e print help spec page 84 Pg e print help spec page 84 e print string page 64 function 36 The Clon Reference Manual push frame page 64 function putenv page 64 function reach column page 64 function read argument page 64 function read call page 65 fu
119. od FACE CLASS Make a FACE CLASS face tree from a list of face name and initargs make face tree NAME symbol amp optional FACE CLASS Method Create a face named NAME mapoptions FUNC THERE Generic Function Map FUNC over all options in THERE Package net didierverna clon page 27 Source synopsis page 19 Lisp file Methods Chapter 6 Definitions mapoptions FUNC CONTEXT context Map FUNC over all options in CONTEXT synopsis Source context page 23 Lisp file mapoptions FUNC ELSEWHERE Do nothing by default mapoptions FUNC ITEM item after Mark TRAVERSABLE as traversed mapoptions FUNC CONTAINER container Map FUNC over all containers or options in CONTAINER mapoptions FUNC OPTION option Call FUNC on OPTION name CONDITION Package net didierverna clon page 27 Methods name CONDITION unknown cmdline option error name FACE face The face name Source face page 20 Lisp file name CONDITION cmdline option error negated call CONDITION Package net didierverna clon page 27 Methods negated call CONDITION unrecognized negated call error negated pack OBJECT Package net didierverna clon page 27 Methods negated pack CONTEXT context Return the negated pack of CONTEXT s synopsis Source context page 23 Lisp file negated pack SYNOPSIS synopsis The negated pack string Source synopsis page 19 Lisp file negated pack char OPTION amp optional A
120. or Didier Verna Contact didier didierverna net Home Page http www lrde epita fr didier software lisp clon php Source Control https github com didierverna clon License BSD Description Clon s preload setup library 8 The Clon Reference Manual Long Description Clon s setup library provides support for various preload configuration parameters For a more complete description of Clon see the net didierverna clon system Definition file net didierverna clon setup asd page 11 Lisp file Component setup page 25 Lisp file Chapter 3 Modules 3 Modules Modules are listed depth first from the system components tree 3 1 core src Dependency neta page 11 Lisp file Parent net didierverna clon core page 7 system Location core src Components e util page 12 Lisp file e item page 12 Lisp file e text page 13 Lisp file e options page 9 module e container page 18 Lisp file e group page 18 Lisp file e retrieval page 10 module e synopsis page 19 Lisp file e output page 10 module e context page 23 Lisp file 3 2 core src options Dependency text page 13 Lisp file Parent src page 9 module Location core src options Components e option page 13 Lisp file e flag page 14 Lisp file e valued page 14 Lisp file e negatable page 15 Lisp file e switch basel page 15 Lisp file e switch page 15 Lisp file e strop
121. p file underline OBJECT Generic Function Package net didierverna clon page 27 Methods underline FACE face Method The face s underline level Source face page 20 Lisp file untraverse ITEM Generic Function Reset ITEM s traversal state and return ITEM Package net didierverna clon page 27 Source item page 12 Lisp file Methods untraverse CONTEXT context Method Untraverse CONTEXT synopsis Source context page 23 Lisp file untraverse CONTAINER container Method Untraverse all CONTAINER items Source container page 18 Lisp file untraverse OPTION option Method OPTION is a terminal object just return it Source option page 13 Lisp file untraverse TEXT text Method TEXT is a terminal object just return it Source text page 13 Lisp file untraverse ITEM item after Method Mark ITEM as untraversed value CONDITION Generic Function Package net didierverna clon page 27 Methods value CONDITION invalid value Method visiblep OBJECT Generic Function Package net didierverna clon page 27 Methods Chapter 6 Definitions 91 visiblep FACE face Method Whether the face is visible Source face page 20 Lisp file yes values OBJECT Generic Function setf yes values NEW VALUE OBJECT Generic Function Package net didierverna clon page 27 Methods yes values SWITCH BASE switch base Method setf yes values NEW VALUE SWITCH BASE
122. p setup lispscui gl ees 25 termio sbcl constants lisp 11 termio termio lisSp c ere to 11 Appendix A Indexes A 2 Functions A OUP ence ties wees Boe gue es eee eR MR epe 50 UNOTSION poses cous wpa PAADI EREI ire aA 52 setf argument styles csse 70 setf cmdline option name 54 setf cmdline option option 54 setf cmdline option source 54 setf cmdline option value 54 setf cmdline options 00 73 setf column A bere saat e 73 setf ertor string vision da eos 76 setf frame left margin esses 56 setf frame right margin sess 56 setf frame sface isses 56 setf frames x244 0 MG DR EGIT beds 76 setf highlight frame highlight property instances sip orinni te cas poo SE 57 setf highlight frame left margin 57 setf highlight frame right margin 57 setf highlight frame sface 57 setf highlight property instance name 58 setf highlight property instance value 58 setf no values sess eese 82 setf traversedp i ves rro rare ER ERE 89 setf winsize ws col 0 0008 69 setf winsize ws roW sseels esses 69 setf winsize ws xpixel suus 69 setf winsize ws ypixel ss sse 70 setf yes values sip uiris tpa cee eee 91 A ACCUMULATE 3 386 horas Bo
123. page 27 Source sheet page 21 Lisp file Direct superclasses face page 102 class Direct methods sibling page 87 method Direct slots sibling Slot The SFace s raw sibling Readers sibling page 87 generic function sheet Class The SHEET class This class implements the notion of sheet for printing Clon help Package net didierverna clon page 27 Source sheet page 21 Lisp file Direct superclasses standard object Direct methods e initialize instance e initialize instance e frames e frames page 76 method e column e column page 73 method e sface tree page 86 method e highlightp page 78 method e line width page 80 method e output stream page 83 method Direct slots output stream Slot The sheet s output stream Type stream Initargs output stream Readers output stream page 83 generic function line width Slot The sheet s line width Type integer 1 Chapter 6 Definitions 111 Initargs line width Readers line width page 80 generic function highlightp Slot Whether to highlight SHEET s output Initargs highlightp Readers highlightp page 78 generic function sface tree Slot The sheet s sface tree Readers sface tree page 86 generic function column Slot The sheet s current column Type integer 0 Initform 0 Readers column page 73 generic function Writers setf column page 73 generic fun
124. page 91 condition e cmdline option page 97 structure e cmdline option error page 92 condition e cmdline option name page 54 function e setf cmdline option name page 54 function e cmdline option option page 54 function e setf cmdline option option page 54 function e cmdline option p page 54 function e cmdline option source page 54 function e setf cmdline option source page 54 function e cmdline option value page 54 function e setf cmdline option value page 54 function e cmdline options page 73 generic function e cndline options page 73 method e setf cmdline options page 73 method e setf cmdline options page 73 generic function e column page 73 generic function e column page 73 method e setf column page 73 method e setf column page 73 generic function e comment page 73 generic function e comment page 73 method e comment page 73 method e complete string page 54 function e concealedp page 73 generic function e concealedp page 74 method e container page 99 class The Clon Reference Manual contents page 74 generic function contents page 74 method context page 100 class generic function method method method method method convert page 74 method convert page 74 convert page 74 convert page 74 convert page 74 convert page 74
125. perclasses e option error page 95 condition e cmdline error page 91 condition Direct subclasses e spurious cmdline argument page 96 condition e invalid negated syntax page 94 condition e invalid cmdline argument page 94 condition e missing cmdline argument page 95 condition Direct methods name page 81 method Direct slots item Slot The option s name as it appears on the command line Initargs name item Readers name page 81 generic function environment error Condition An error related to an environment variable Package net didierverna clon page 27 Source environ page 19 Lisp file Direct superclasses error Direct subclasses environmental option error page 93 condition Direct methods env var page 75 method Direct slots env var Slot The concerned environment variable Initargs env var Readers env var page 75 generic function Chapter 6 Definitions 93 environmental option error Condition An error related to an option s environment variable Package net didierverna clon page 27 Source environ page 19 Lisp file Direct superclasses e option error page 95 condition e environment error page 92 condition Direct subclasses invalid environment value page 94 condition home directory Condition Package net didierverna clon page 27 Source util page 12 Lisp file Direct superclasses warning D
126. perties 50 Special Variable item names 50 Special Variable readtable 50 Special Variable release major level 41 Special Variable release minor level 41 Special Variable release name 41 Special Variable release status 41 Special Variable release status level 41 Special Variable synopsis 41 Special Variable configuration 42 S bfac8s reri aiae ld 106 SYNOPSIS Li AS 101 T OM a A QUUD OE 101 top padding a a ed 104 LLAVES Piti RUPTURE UC EDDIE 107 typespeCc e b LB pis 107 U underlin8 4 d ynrertk i 1400 REECCE PR 105 V Value cedit meses ia 95 98 99 YASXDIOD ue uhiesbeti eee etr wed 103 Y NOSTVALUES IA T ae Pee eee 112 128 A 4 Data types A abstract class mii cas 99 a Class abstract class esses eese 99 Class COMA Ian a eo ri wig 99 Glass context ioIguwIend Hue IRE AS 100 Class enum esane ranas oa 102 Class num base aiii da da ee ded 102 Class fate pe o coo 102 lass flags neni sidan o 106 Class Ero p A Ada 106 lass item il ia 106 Class 138pobj c e ita 107 Class negatable cese 108 Class options eco pe eet ye erben pei sr 108 Class path asta ke VLDE NIRE SET FOR E S 109 Class Sface uem a AN EP DERE 110 C las8 Sheet ip ruber E E he aaledy 110 Classsstropticiii a E 111 Class Switch cachovcads doers boved
127. ponent null p sess 63 popsframej 21 nieno netoen eha ISSUE t ds 63 postfixcg ia cda Ee 83 potential pack wi eerie igs abe dene ieu 83 84 potential pack char cece 63 potential pack p E EEEE E 84 princ har sedynes a As a 63 princ highlight property instances 63 princ spaces ue d een Soho we ss 63 PEINCHSTLING coi a RV RE 63 print error ioweulerherssTwstevDe eb satt vs 64 print faced help spec esses 64 print hel pie its ot late She a 64 print help spitis siri res nina a vere un Mer 84 pint STE esini i En E eio k Een ape E 64 progname sgg eI AVETE MEG AS 48 push frame 16b RERBA BRIDE MEM S 64 A ilg e De eA IQ E RN a 64 R reach column icoesluciu pasha te ee e 9 RA EDO 64 f ad arg ment inler edes eR rx 64 read wa X US S b was es 65 r ad env V lios luas at o xt A Rd viele 65 read long name sess 65 Yead sface tree 22 6 deel chee aA a 65 Ted Vall coi da 65 release status number 0 cece eee 65 remainder citrico Sein 48 remove keyS neIitiuieswbphoeeWdrbceie dub dee 65 repl ce in k8yS iioii5e il lbi pre LII rn 52 A A p liRWi6tefe NEFES ES 65 replace k yS i i 1g ida ice 66 restart n error j boi e ia 66 restartable check esses 66 restartable cmdline convert 66 restartable cmdline junk error 66 restartable convert i oe lY e LAT 67 The Clon Reference Man
128. quired mandatory or optional required and mandatory are synonyms It defaults to optional ENV VAR is the option s associated environment variable sans the CLON_ prefix It defaults to nil FALLBACK VALUE is the option s fallback value for missing optional arguments if any DEFAULT VALUE is the option s default value if any TYPE is the pathname type It can be one of file directory file list directory list or nil meaning that everything is allowed When HIDDEN the option doesn t appear in help strings Package net didierverna clon page 27 Source path page 16 Lisp file make internal stropt LONG NAME DESCRIPTION amp rest KEYS amp key Function ARGUMENT NAME ARGUMENT TYPE ENV VAR FALLBACK VALUE DEFAULT VALUE HIDDEN Make a new internal Clon specific string option LONG NAME is the option s long name sans the clon prefix Internal options don t have short names DESCRIPTION is the options s description ARGUMENT NAME is the option s argument name appearing in help strings ARGUMENT TYPE is one of required mandatory or optional required and mandatory are synonyms It defaults to optional ENV VAR is the option s associated environment variable sans the CLON_ prefix It defaults to nil FALLBACK VALUE is the option s fallback value for missing optional arguments if any DEFAULT VALUE is the option s default value if any W
129. ration Package net didierverna clon setup page 39 Source setup page 25 Lisp file exit amp optional STATUS Function Quit the current application with STATUS Package net didierverna clon page 27 Source util page 12 Lisp file getopt amp rest KEYS amp key CONTEXT SHORT NAME LONG NAME Function OPTION Get an option s value in CONTEXT The option can be specified either by SHORT NAME LONG NAME or directly via an OPTION object Return two values the retrieved value the value s source Package net didierverna clon page 27 Source context page 23 Lisp file getopt cmdline amp key CONTEXT Function Get the next command line option in CONTEXT When there is no next command line option return nil Otherwise return four values the option object the option s name used on the command line the retrieved value the value source Package net didierverna clon page 27 Source context page 23 Lisp file help amp key CONTEXT ITEM OUTPUT STREAM SEARCH PATH THEME Function LINE WIDTH HIGHLIGHT Print CONTEXT s help Package net didierverna clon page 27 Source context page 23 Lisp file make context amp rest KEYS amp key SYNOPSIS CMDLINE MAKE CURRENT Function Make a new context SYNOPSIS is the program synopsis to use in that context It defaults to SYNOPSIS CMDLINE is the argument list strings to process It defaults to a POSIX conformant argv
130. rce face page 20 Lisp file pathname component null p COMPONENT Function Return true if COMPONENT is either null or unspecific Package net didierverna clon page 27 Source path page 16 Lisp file pop frame SHEET Function Pop SHEET s current frame Package net didierverna clon page 27 Source sheet page 21 Lisp file potential pack char OPTION amp optional AS STRING Function Return OPTION s potential pack character if any If AS STRING return a string of that character Package net didierverna clon page 27 Source option page 13 Lisp file princ char SHEET CHAR Function Princ CHAR on SHEET s stream and increment the column position The effect of printing CHAR must be exactly to move right by one column so control char acters as well as newlines and tabs are forbidden here Package net didierverna clon page 27 Source sheet page 21 Lisp file princ highlight property instances SHEET INSTANCES Function Princ highlight proeprty INSTANCES on SHEET s stream Package net didierverna clon page 27 Source sheet page 21 Lisp file princ spaces SHEET NUMBER Function Princ NUMBER spaces to SHEET s stream and update the column position Package net didierverna clon page 27 Source sheet page 21 Lisp file princ string SHEET STRING Function Princ STRING on SHEET s stream and update the column position The effect of printing STRING must be exactly to move r
131. re src options option lisp 13 Lisp File core src options path lisp 16 Lisp File core src options stropt lisp 16 Lisp File core src options switch base lisp 15 Lisp File core src options switch lisp 15 Lisp File core src options valued lisp 14 Lisp File core src options xswitch lisp 17 Lisp File core src output face lisp 20 Lisp File core src output sheet lisp 21 Lisp File core src retrieval cmdline lisp 18 Lisp File core src retrieval environ lisp 19 Lisp File core src synopsis lisp 19 Lisp File core src text lisp 13 Lisp File core src util lisp 12 Lisp File net didierverna clon asd 11 Lisp File net didierverna clon core asd 11 Lisp File net didierverna clon setup asd 11 Lisp File net didierverna clon termio asd 11 Lisp File setup setup lisp ss 25 Lisp File termio sbcl constants lisp 11 Lisp File termio termio lisp 11 M Module core src eee eee eee eee eee eens 9 Module core src options 005 9 Module core src output 0004 10 Module core src retrieval 10 N net didierverna clon asd 005 11 net didierverna clon core asd 11 net didierverna clon setup asd 11 net didierverna clon termio asd 11 setu
132. ric function name page 81 method name page 81 method name page 81 method negatable page 108 class negated call page 81 generic function negated call page 81 method negated pack page 81 generic function negated pack page 81 method negated pack page 81 method negated pack char page 81 generic function negated pack char page 82 method negated pack char page 82 method no values page 82 generic function no values page 82 method setf no values page 82 method setf no values page 82 generic function offset of winsize ws col page 49 constant offset of winsize ws row page 49 constant offset of winsize ws xpixel page 49 constant offset of winsize ws ypixel page 49 constant open frame page 82 generic function open frame page 82 method open frame page 82 method open line page 62 function open next line page 62 function Chapter 5 Packages 35 e open sface page 62 function e option page 82 generic function e option page 82 method e option page 108 class e option abbreviation distance page 62 function e option cal1 p page 62 function e option error page 95 condition e option sticky distance page 82 generic function e option sticky distance page 83 method e option sticky distance page 83 method e output stream page 83 generic function e output stream page 83 meth
133. rint string ccc cece cece eee 64 prognata iiei i hse Tas dat se 48 push frame o eccle eie ERA 64 putenyeccheNpSibe Aa 64 Teach CoOlumn scssi tases vanes termes 64 read argument 0 eee oc 64 Head cal ii ds 65 read env val cc cee eee 65 read long name 000005 65 read sface tree eee 65 Tead Value sis heey ie e he 65 release status number 65 remainder E alae dienes A 48 remove keys i o ill ll piy ini 65 replace key ix tmu reb gue un 65 replace keys cece ee eee 66 restart on error cmo cie 66 restartable check oooooooo o 66 restartable cmdline convert 66 restartable cmdline junk error 66 restartable convert 67 restartable environment convert 67 restrict because 0005 67 safe left margin 67 safe right margin 67 search branch AAA 67 SOT CO TACO coa A 68 search option necio bird 68 search option by abbreviation 68 search option by name 68 search sticky option 68 Select keyS 0 o n be E IS 69 setup termio ic l eade es 48 split pathic ay oe ble tora 69 stream line Width oooooomoo 69 tildezreader lv is 69 try read sface tree 69 try read theme cc cece ees 69 VOTO ici e a iei ees 48 winsize ws col eee 69 WiNSiZe WS IOW oooccococccccccccccc 69
134. s option CONDITION Generic Function Package net didierverna clon page 27 Methods option CONDITION option error Method option sticky distance OPTION NAMEARG Generic Function Try to match OPTION s short name with a sticky argument against NAMEARG If OPTION matches return the length of OPTION s short name otherwise 0 Package net didierverna clon page 27 Source option page 13 Lisp file Methods Chapter 6 Definitions 83 option sticky distance OPTION valued option Method NAMEARG Try to match OPTION s short name with a sticky argument against NAMEARG If OPTION matches return its short name s length otherwise 0 Source valued page 14 Lisp file option sticky distance OPTION option NAMEARG Method Return 0 non valued options don t take any argument sticky or not output stream OBJECT Package net didierverna clon page 27 Methods output stream SHEET sheet The sheet s output stream Source sheet page 21 Lisp file parent OBJECT Package net didierverna clon page 27 Methods parent FACE face The face parent Source face page 20 Lisp file path type OBJECT Package net didierverna clon page 27 Methods path type PATH path The path type Source path page 16 Lisp file postfix OBJECT Package net didierverna clon page 27 Methods postfix CONTEXT context Return the postfix of CONTEXT s synopsis Source context page 23 Lisp file postfix SYN
135. s VALUE into an argument Source xswitch page 17 Lisp file stringify ENUM enum VALUE Transform ENUM s VALUE into an argument Source enum page 17 Lisp file stringify PATH path VALUE Transform PATH s VALUE into an argument Source path page 16 Lisp file stringify LISPOBJ lispobj VALUE Transform LISPOBJ s VALUE into an argument Source lispobj page 16 Lisp file stringify STROPT stropt VALUE Transform STROPT s VALUE into an argument Source stropt page 16 Lisp file stringify SWITCH switch VALUE Transform SWITCH s VALUE into an argument Source switch page 15 Lisp file subface FACE name s Return subface of FACE named NAME S or nil If a list of names is provided instead of a single one follow a subface branch matching those names to find the leaf face Package Source Methods net didierverna clon page 27 face page 20 Lisp file subface FACE NAME symbol Return FACE subface named NAME or nil subface FACE NAMES list amp aux BRANCH Method Method Method Generic Function Method Method Method Method Method Method Generic Function Method Method Return the leaf face from FACE subbranch matching NAMES or nil Chapter 6 Definitions subfaces OBJECT Package net didierverna clon page 27 Methods subfaces FACE face The face children Source face page 20 Lisp file synopsis OBJEC
136. s long name sans the clon prefix Internal options don t have short names DESCRIPTION is the xswitch s description ARGUMENT NAME is the option s argument name appearing in help strings ARGUMENT TYPE is one of required mandatory or optional required and mandatory are synonyms It defaults to optional ENUM is the set of possible non boolean values ENV VAR is the xswitch s associated environment variable sans the CLON_ prefix It defaults to nil DEFAULT VALUE is the xswitch s default value if any When HIDDEN the option doesn t appear in help strings Package net didierverna clon page 27 Source xswitch page 17 Lisp file make raw face tree amp optional FACE CLASS Function Make a raw boring yet functional face tree Package net didierverna clon page 27 Source face page 20 Lisp file 62 The Clon Reference Manual make raw sface SIBLING amp aux SFACE Return a new SFace based on SIBLING This function does not consider SIBLING as a face tree only face properties are copied the face parent and children are set to nil Package net didierverna clon page 27 Source sheet page 21 Lisp file make sheet amp rest KEYS amp key OUTPUT STREAM SEARCH PATH THEME LINE WIDTH HIGHLIGHT Make a new SHEET Package net didierverna clon page 27 Source sheet page 21 Lisp file match option OPTION amp key SHORT NAME LONG NAME Try to match OPTION against SH
137. s serene 111 Class switch base 0 eee eee eee 112 Class SYDOPS S bi shee bie cap Be nea Ren EV 113 Class texturas es 114 Class valued option 00 0000 114 Class xswitch si ost soso sagan PIER TEE 116 cmdline COn A en exu eS 91 cmdline junk error cece 91 emdline option ati erick hide teens 97 cmdline option error cee eee eee 92 Condition cmdline error sss 91 Condition cndline junk error 91 Condition cmdline option error 92 Condition environment error 92 Condition environmental option error 93 Condition home directory sess 93 Condition invalid argument 93 Condition invalid cmdline argument 94 Condition invalid environment value 94 Condition invalid negated equal syntax 94 Condition invalid negated syntax 94 Condition invalid short equal syntax 95 Condition invalid value sssses 95 Condition missing cmdline argument 95 Condition option error esssssssse 95 Condition spurious cmdline argument 96 Condition unknown cmdline option error 96 Condition unrecognized negated call error 97 Condition unrecognized short call error 97 container olde RISRNNaR ra Nos 99 CONTE ER ii 100 MM EL 102 enum b as6 ica si ra 102 environment error eee
138. se page 90 generic function untraverse page 90 method untraverse page 90 method untraverse page 90 method untraverse page 90 method untraverse page 90 method value page 90 generic function value page 90 method valued option page 114 class visiblep page 90 generic function visiblep page 91 method winsize ws col page 69 function setf winsize ws col page 69 function winsize ws row page 69 function Chapter 5 Packages 39 setf winsize ws row page 69 function winsize ws xpixel page 69 function setf winsize ws xpixel page 69 function winsize ws ypixel page 70 function setf winsize ws ypixel page 70 function with context error handler page 52 macro with winsize page 52 macro xswitch page 116 class yes values page 91 generic function yes values page 91 method setf yes values page 91 method setf yes values page 91 generic function 5 2 net didierverna clon setup The Command Line Options Nuker setup Source setup page 25 Lisp file Use List common lisp Used By List net didierverna clon page 27 Exported Definitions release major level page 41 special variable release minor level page 41 special variable release name page 41 special variable release status page 41 special variable release status level page 41 special variable configuration page 42 specia
139. sequence page 57 function highlight property instance name page 58 function setf highlight property instance name page 58 function highlight property instance p page 58 function highlight property instance value page 58 function setf highlight property instance value page 58 function highlightp page 78 method line width page 80 method make frame page 58 function make highlight frame page 59 function make highlight property instance page 59 function make raw sface page 62 function make sheet page 62 function map frames page 51 macro open frame page 82 generic function open frame page 82 method open frame page 82 method open line page 62 function open next line page 62 function open sface page 62 function output stream page 83 method pop frame page 63 function Chapter 4 Files 23 princ char page 63 function princ highlight property instances page 63 function princ spaces page 63 function princ string page 63 function print faced help spec page 64 function print help page 64 function page 84 generic function method method method method page 84 method print help spec print help spec page 84 print help spec page 84 print help spec page 84 A print help spec page 84 SSNS SN print help spec print string page 64 function push frame page 64 function reac
140. setup page 7 system Location setup setup lisp Packages net didierverna clon setup page 39 Exported Definitions release major level page 41 special variable release minor level page 41 special variable release name page 41 special variable release status page 41 special variable release status level page 41 special variable configuration page 42 special variable configuration page 43 function configure page 44 function setup termio page 48 function version page 48 function Internal Definitions version page 52 function release status number page 65 function restrict because page 67 function Chapter 5 Packages 27 5 Packages Packages are listed by definition order 5 1 net didierverna clon The Command Line Options Nuker package Source neta page 11 Lisp file Use List e net didierverna clon setup page 39 e common lisp Exported Definitions e context page 41 special variable e synopsis page 41 special variable e cmdline page 43 function e cmdline options p page 43 function e cmdline p page 43 function e defgroup page 42 macro e defsynopsis page 42 macro e do cmdline options page 42 macro e dump page 42 macro e exit page 44 function e getopt page 44 function e getopt cmdline page 44 function e help page 44 function e make context page 44 function e mak
141. sp core src options stropt lisp File Lisp core src options switch base lisp File Lisp core src options switch lisp File Lisp core src options valued lisp File Lisp core src options xswitch lisp File Lisp core src output face lisp File Lisp core src output sheet lisp File Lisp core src retrieval cmdline lisp File Lisp core src retrieval environ lisp File Lisp core src synopsis lisp File Lisp core src text lisp File Lisp core src util lisp File Lisp net didierverna clon File Lisp net didierverna clon core asd File Lisp net didierverna clon setup asd File Lisp net didierverna clon termio asd The Clon Reference Manual File Lisp setup setup lisp 25 File Lisp termio sbcl constants lisp 11 File Lisp termio termio lisp 11 L Lisp File core meta lisp s eee eee 11 Lisp File core src container lisp 18 Lisp File core src context lisp 23 Lisp File core src group lisp 18 Lisp File core src item lisp 12 Lisp File core src options enum base lisp 17 Lisp File core src options enum lisp 17 Lisp File core src options flag lisp 14 Lisp File core src options lispobj lisp 16 Lisp File core src options negatable lisp 15 Lisp File co
142. spec CONTAINER container amp key Return CONTAINER s help specification Source container page 18 Lisp file help spec OPTION valued option amp key Return OPTION s help specification Source valued page 14 Lisp file help spec OPTION option amp key Return OPTION s help specification Source option page 13 Lisp file help spec TEXT text amp key Return TEXT s help specification Source text page 13 Lisp file 77 Generic Function Method Method Generic Function Method Generic Function Method Method Method Method Method Method 78 The Clon Reference Manual help spec ITEM item amp key UNHIDE around Method Call the actual method only when ITEM is not hidden or UNHIDE help spec will print SFACE HELP SPEC Generic Function Return t if HELP SPEC will print under FACE Package net didierverna clon page 27 Source sheet page 21 Lisp file Methods help spec will print SFACE HELP SPEC before Method help spec will print SFACE HELP SPEC Method Basic help specifications chars strings etc do print help spec will print SFACE HELP SPEC list Method Return t if HELP SPEC s items will print under HELP SPEC s face hiddenp OBJECT Generic Function Package net didierverna clon page 27 Methods hiddenp ITEM item Method Whether the item is hidden in help strings Source item page 12 Lisp file highlight OBJECT Generic
143. src options enum lisp sss core src options flag lisp ss core src options lispobj lisp core src options negatable lisp core src options option lisp core src options path lisp sess core src options stropt lisp core src options switch base lisp core src options switch lisp core src options valued lisp core src options xswitch lisp core src output sssseeeee ee core src output face lisp sess core src output sheet lisp suse core src retrieval cesses core src retrieval cmdline lisp core src retrieval environ lisp core src synopsis lisp sess cor src text lisp o aran core src util lisp 2 2l epp eR F File Lisp core meta lisp sss File Lisp core src container lisp File Lisp core src context lisp File Lisp core src group lisp File Lisp core src item lisp File Lisp core src options enum base lisp File Lisp core src options enum lisp File Lisp core src options flag lisp File Lisp core src options lispobj lisp File Lisp core src options negatable lisp File Lisp core src options option lisp File Lisp core src options path lisp File Li
144. superclasses frame page 98 structure Direct methods e close frame page 73 method e open frame page 82 method Chapter 6 Definitions 99 Direct slots highlight property instances Slot Readers highlight frame highlight property instances page 57 function Writers setf highlight frame highlight property instances page 57 function highlight property instance Structure The HIGHLIGHT PROPERTY INSTANCE structure Package net didierverna clon page 27 Source sheet page 21 Lisp file Direct superclasses structure object Direct slots name Slot Readers highlight property instance name page 58 function Writers setf highlight property instance name page 58 func tion value Slot Readers highlight property instance value page 58 function Writers setf highlight property instance value page 58 func tion 6 2 8 Classes abstract class Class The ABSTRACT CLASS class This is the meta class for abstract classes Package net didierverna clon page 27 Source util page 12 Lisp file Direct superclasses standard class Direct methods e validate superclass e validate superclass e make instance container Class The CONTAINER class This class is a mixin used in synopsis and groups to represent the program s command line hierarchy Package net didierverna clon page 27 Source container page 18 Lisp file Direct superclasses item pa
145. switch base Method setf argument styles NEW VALUE SWITCH BASE Method switch base The possible argument styles The position of every argument style in the list must correspond to the position of the associated strings in the yes values and no values slots Source switch base page 15 Lisp file Chapter 6 Definitions background OBJECT Package Methods net didierverna clon page 27 background FACE face The face background Source face page 20 Lisp file blink OBJECT Package Methods net didierverna clon page 27 blink FACE face The face s blink speed Source face page 20 Lisp file bottom padding OBJECT Package Methods net didierverna clon page 27 bottom padding FACE face The face bottom padding This property can take the following forms 71 Generic Function Method Generic Function Method Generic Function Method nil the next output can start right at the end of this face s 0 the next output should start on the next line N gt 0 there should be N empty lines before the next output Source face page 20 Lisp file check VALUED OPTION VALUE Check that VALUE is valid for VALUED OPTION If VALUE is valid return it Otherwise raise an invalid value error Package Source Methods net didierverna clon page 27 valued page 14 Lisp file check XSWITCH xswitch VALUE Check that VALUE is valid for XSW
146. synopsis Initform net didierverna clon synopsis Readers synopsis page 89 generic function progname The program name as it appears on the command line Type string cmdline options The options from the command line Type list Readers cmdline options page 73 generic function Writers setf cmdline options page 73 generic function remainder The non Clon part of the command line Type list search path The search path for Clon files Readers search path page 86 generic function theme The theme filename Readers theme page 89 generic function line width The line width for help display Readers line width page 80 generic function highlight Clon s output highlight mode Readers highlight page 78 generic function error handler The behavior to adopt on option retrieval errors Type symbol Initform quit Readers error handler page 76 generic function 101 Slot Slot Slot Slot Slot Slot Slot Slot Slot 102 The Clon Reference Manual Direct Default Initargs Initarg Value cmdline net didierverna clon cmdline enum Class The ENUM class This class implements options whose values belong to a set of keywords Package net didierverna clon page 27 Source enum page 17 Lisp file Direct superclasses e valued option page 114 class e enum base page 102 class Direct methods e convert pag
147. t page 16 Lisp file e lispobj page 16 Lisp file e path page 16 Lisp file e enum base page 17 Lisp file e enum page 17 Lisp file e xswitch page 17 Lisp file 10 The Clon Reference Manual 3 3 core src retrieval Dependency options page 9 module Parent src page 9 module Location core src retrieval Components e cmdline page 18 Lisp file e environ page 19 Lisp file 3 4 core src output Dependencies e synopsis page 19 Lisp file e retrieval page 10 module Parent src page 9 module Location core src output Components e face page 20 Lisp file e sheet page 21 Lisp file Chapter 4 Files 11 4 Files Files are sorted by type and then listed depth first from the systems components trees 4 1 Lisp 4 1 1 net didierverna clon asd Location net didierverna clon asd 4 1 2 net didierverna clon termio asd Location termio net didierverna clon termio asd 4 1 3 net didierverna clon core asd Location core net didierverna clon core asd 4 1 4 net didierverna clon setup asd Location setup net didierverna clon setup asd 4 1 5 termio sbcl constants lisp If Feature sbcl Parent net didierverna clon termio page 5 system Location termio sbcl constants lisp 4 1 6 termio termio lisp Dependency sbcl constants page 11 Lisp file Parent net didierverna clon termio page 5 system Location termio termio lisp I
148. t didierverna clon page 27 Source cmdline page 18 Lisp file Methods retrieve from negated call OPTION option Method retrieve from negated call OPTION valued option Method retrieve from negated call NEGATABLE negatable Method retrieve from short call OPTION amp optional Generic Function CMDLINE ARGUMENT CMDLINE Retrieve OPTION s value from a short call CMDLINE ARGUMENT is a potentially already parsed cmdline argument Otherwise CMDLINE is where to find an argument This function returns three values the retrieved value the value source the new command line possibly with the first item popped if the option requires an argu ment Package net didierverna clon page 27 Source cmdline page 18 Lisp file Methods retrieve from short call OPTION option amp optional Method CMDLINE ARGUMENT CMDLINE retrieve from short call OPTION valued option Method amp optional CMDLINE ARGUMENT CMDLINE 86 The Clon Reference Manual right padding OBJECT Generic Function Package net didierverna clon page 27 Methods right padding FACE face Method The face right padding This property can take the following forms NUMBER the padding is relative to the enclosing face SELF the padding is set to wherever the face happens to be closed lt NUMBER gt ABSOLUTE the padding is set in absolute value lt NUMBER gt RELATIVE TO lt FACE NAME gt the padding is set rela tively t
149. t frame right margin INSTANCE Function setf highlight frame right margin VALUE INSTANCE Function Package net didierverna clon page 27 Source sheet page 21 Lisp file highlight frame sface INSTANCE Function setf highlight frame sface VALUE INSTANCE Function Package net didierverna clon page 27 Source sheet page 21 Lisp file highlight property instance escape sequence INSTANCE Function Return highlight property INSTANCE s escape sequence Package net didierverna clon page 27 Source sheet page 21 Lisp file 58 The Clon Reference Manual highlight property instance name INSTANCE setf highlight property instance name VALUE INSTANCE Package net didierverna clon page 27 Source sheet page 21 Lisp file highlight property instance p OBJECT Package net didierverna clon page 27 Source sheet page 21 Lisp file highlight property instance value INSTANCE setf highlight property instance value VALUE INSTANCE Package net didierverna clon page 27 Source sheet page 21 Lisp file home directory Return user s home directory in canonical form Function Function Function Function Function Function If the user s home directory cannot be computed signal a warning and return NIL Package net didierverna clon page 27 Source util page 12 Lisp file i reader STREAM SUBCHAR ARG Read an argument list for the DEFINDENT macro Package n
150. ta and rc status are ignored in version numbers Chapter 6 Definitions 49 A short version is something like 1 3 a b rc 4 or 1 3 4 for patchlevel Alpha beta or rc levels start at 1 Patchlevels start at 0 but are ignored in the output so that 1 3 0 appears as just 1 3 A long version is something like 1 3 alpha beta release candidate patchlevel 4 Michael Brecker As for the short version a patchlevel of 0 is ignored in the output Package net didierverna clon setup page 39 Source setup page 25 Lisp file 6 2 Internal definitions 6 2 1 Constants tiocgwinsz Constant NIL Package net didierverna clon page 27 Source Users didier cache common lisp sbcl 1 2 13 35 6102b24 macosx x64 Users didier offset of winsize ws col Constant Package net didierverna clon page 27 Source Users didier cache common lisp sbcl 1 2 13 35 6102b24 macosx x64 Users didier offset of winsize ws row Constant Package net didierverna clon page 27 Source Users didier cache common lisp sbcl 1 2 13 35 6102b24 macosx x64 Users didier offset of winsize ws xpixel Constant Package net didierverna clon page 27 Source Users didier cache common lisp sbcl 1 2 13 35 6102b24 macosx x64 Users didier offset of winsize ws ypixel Constant Package net didierverna clon page 27 Source Users didier cache common lisp sbcl 1 2 13 35 6102b24 macosx x64 Users didier size of winsize Constant Package net didierverna clon
151. tf cmdline option name VALUE INSTANCE Package net didierverna clon page 27 Source context page 23 Lisp file cmdline option option INSTANCE setf cmdline option option VALUE INSTANCE Package net didierverna clon page 27 Source context page 23 Lisp file cmdline option p OBJECT Package net didierverna clon page 27 Source context page 23 Lisp file cmdline option source INSTANCE setf cmdline option source VALUE INSTANCE Package net didierverna clon page 27 Source context page 23 Lisp file cmdline option value INSTANCE setf cmdline option value VALUE INSTANCE Package net didierverna clon page 27 Source context page 23 Lisp file complete string BEGINNING COMPLETE Complete BEGINNING with the rest of COMPLETE in parentheses For instance completing he with help will produce he Ip Package net didierverna clon page 27 Source util page 12 Lisp file Function Function Function Function Function Function Function Function Function Function Chapter 6 Definitions copy cmdline option INSTANCE Package net didierverna clon page 27 Source context page 23 Lisp file copy frame INSTANCE Package net didierverna clon page 27 Source sheet page 21 Lisp file copy highlight frame INSTANCE Package net didierverna clon page 27 Source sheet page 21 Lisp file copy highlight property instance IN
152. tf frames NEW VALUE OBJECT Package Methods net didierverna clon page 27 frames SHEET sheet setf frames NEW VALUE SHEET sheet The stack of currently open frames Source sheet page 21 Lisp file Generic Function Method Generic Function Generic Function Method Method Generic Function Method Generic Function Method Generic Function Method Generic Function Generic Function Method Method Chapter 6 Definitions get bottom padding SFACE HELP SPEC Get HELP SPEC s bottom padding under SFACE Package net didierverna clon page 27 Source sheet page 21 Lisp file Methods get bottom padding SFACE HELP SPEC Basic help specifications chars strings etc don t provide a bottom padding get bottom padding SEACE HELP SPEC list Return the bottom padding of HELP SPEC s face header OBJECT Package net didierverna clon page 27 Methods header GROUP group The group s header Source group page 18 Lisp file help spec ITEM amp key UNHIDE PROGRAM amp allow other keys Return ITEM s help specification Package net didierverna clon page 27 Source item page 12 Lisp file Methods help spec SYNOPSIS synopsis amp key PROGRAM Return SYNOPSIS s help specification Source synopsis page 19 Lisp file help spec GROUP group amp key Return GROUP s help specification Source group page 18 Lisp file help
153. to the values returned by GETOPT CMDLINE BODY is executed only if there is a next command line option Package net didierverna clon page 27 Source context page 23 Lisp file with context CONTEXT amp body BODY Macro Execute BODY with context bound to CONTEXT Package net didierverna clon page 27 Source context page 23 Lisp file 6 1 3 Functions cmdline Function Get the current application s command line This command line is not supposed to contain any Lisp implementation specific option only user level ones When a standalone executable is dumped this is always the case When used interactively this depends on the underlying Lisp implementation See appendix A 5 of the user manual for more information Package net didierverna clon page 27 Source util page 12 Lisp file cmdline options p amp key CONTEXT Function Return T if CONTEXT has any unprocessed options left Package net didierverna clon page 27 Source context page 23 Lisp file cmdline p amp key CONTEXT Function Return T if CONTEXT has anything on its command line Package net didierverna clon page 27 Source context page 23 Lisp file configuration KEY Function Return KEY s value in the current Clon configuration Package net didierverna clon setup page 39 Source setup page 25 Lisp file 44 The Clon Reference Manual configure KEY VALUE Function Set KEY to VALUE in the current Clon configu
154. tp www lrde epita fr didier software lisp clon php Source Control https github com didierverna clon License BSD Description Clon s support for automatic configuration of termio support Long Description This is a virtual subsystem or Clon no actual code Its purpose is only to autode tect termio support and update Clon s preload configuration on load For a more complete description of Clon see the net didierverna clon system Chapter 2 Systems 7 Dependency net didierverna clon setup page 7 system Definition file net didierverna clon setup asd page 11 Lisp file 2 4 net didierverna clon core Long Name The Command Line Options Nuker core library Author Didier Verna Contact didier didierverna net Home Page http www lrde epita fr didier software lisp clon php Source Control https github com didierverna clon License BSD Description Clon s basic platform independent functionality Long Description Clon s core library provides the platform feature independent part For a more complete description of Clon see the net didierverna clon system Dependencies e net didierverna clon setup page 7 system e required module sb posix for feature sbc1 Definition file net didierverna clon core asd page 11 Lisp file Components e meta page 11 Lisp file e src page 9 module 2 5 net didierverna clon setup Long Name The Command Line Options Nuker setup library Auth
155. ual restartable environment convert 67 restartable invalid negated syntax error 52 restartable spurious cmdline argument error LAM e E m D M UD D sta PAESE 52 restrict because a ld E LEER 67 retrieve from environment 84 retrieve from long call 85 retrieve from negated call 85 retrieve from short call sss 85 Eight padding yo ii E AER eee 86 S saf left margin o ice eases os ee on 67 safe right margin cc cc eee 67 Search branclhi iii wae E 67 Se arch faces i662 poet bs as doer Deb on 68 search option co n ege DIA Meee ents ts 68 search option by abbreviation 68 search option by name 0 0 c eee eee 68 search path i da tec ehe 86 search sticky option 00005 68 select keysS secs 2 n ets 69 setup termio ilie Lille denise elg a 48 Sface tree avs sevi YR REA Y ATE ERES 86 Short call oss nase ths v EON UAE Nis tava ha Us UR 86 short name a 86 Short APA ek imita tad hatos 86 87 short pack chars cid 87 short syntax help spec prefix 8T Biblici esp diee suae nbus dan wee bus 87 Splitapathy 2i 2iGi iii da bin Wu 69 stream ioctl output handle 87 88 stream line width 0 0 eee 69 Stringify itolip b eat A he ea 88 SUDLACE Haste kede wh hena Wehen s bb DEL ERE 88 SUBEACES woth ones vx ihe adas 89 SNOOP a la de 8
156. urce util page 12 Lisp file replace key REPLACEMENT KEYS Function Return a new property list from KEYS with REPLACEMENT REPLACEMENT can take the following forms KEY The effect is to remove KEY from KEYS as per REMOVE KEYS CKEY NEW KEY The effect is to replace KEY with NEW KEY leaving the values unchanged CKEY NEW KEY VAL OR VALS NEW VAL with VAL OR VALS being either a value or a list of values The effect is to replace KEY with NEW KEY and a value matching one of the VAL OR VALS with the corresponding NEW VAL Values not matching any VAL OR VALS remain unchanged KEY VAL OR VALS NEW KEY NEW VAL with VAL OR VALS as above The effect is the same as above but NEW KEY additionally depends on the matched value If 66 The Clon Reference Manual multiple NEW KEY NEW VAL couples are provided that many new keys are inserted along with their values For values not matching any VAL OR VALS KEY and its value remain unchanged Package net didierverna clon page 27 Source util page 12 Lisp file replace keys KEYS amp rest REPLACEMENTS amp aux NEW KEYS Function Return a new property list from KEYS with REPLACEMENTS See REPLACE KEY for more information on the replacement syntax Package net didierverna clon page 27 Source util page 12 Lisp file restart on error ERROR Function Print ERROR and offer available restarts on QUERY IO Package net didierverna clon pag

The Clon Reference Manual - LRDE

Contents

Download Pdf Manuals

Related Search

Related Contents