From 6a8232a5d86c967b52defc61e3e8fee1cc8a9239 Mon Sep 17 00:00:00 2001 From: Julian Noble Date: Sun, 24 Nov 2024 05:08:13 +1100 Subject: [PATCH] documentation update --- src/doc/_module_argparsingtest-0.1.0.tm.man | 2 +- src/doc/_module_fauxlink-0.1.1.tm.man | 71 +++ ...1.0.tm.man => _module_modpod-0.1.2.tm.man} | 2 +- src/doc/_module_overtype-1.6.3.tm.man | 49 -- src/doc/_module_overtype-1.6.4.tm.man | 49 -- src/doc/_module_overtype-1.6.5.tm.man | 2 +- src/doc/_module_poshinfo-0.1.0.tm.man | 13 +- src/doc/_module_textblock-0.1.1.tm.man | 2 +- src/doc/_module_textblock-0.1.2.tm.man | 120 ++++ src/doc/_module_tomlish-1.1.1.tm.man | 20 +- src/doc/punk/_module_aliascore-0.1.0.tm.man | 6 +- src/doc/punk/_module_ansi-0.1.1.tm.man | 4 + src/doc/punk/_module_assertion-0.1.0.tm.man | 2 +- src/doc/punk/_module_basictelnet-0.1.0.tm.man | 4 +- src/doc/punk/_module_blockletter-0.1.0.tm.man | 45 ++ src/doc/punk/_module_cesu-0.1.0.tm.man | 36 ++ src/doc/punk/_module_experiment-0.1.0.tm.man | 2 +- src/doc/punk/_module_island-0.1.0.tm.man | 2 +- src/doc/punk/_module_lib-0.1.1.tm.man | 17 +- .../_module_packagepreference-0.1.0.tm.man | 8 +- src/doc/punk/_module_rest-0.1.0.tm.man | 42 ++ src/doc/punk/_module_sshrun-0.1.0.tm.man | 2 +- src/doc/punk/_module_trie-0.1.0.tm.man | 39 ++ src/doc/punk/_module_uc-0.1.0.tm.man | 4 +- src/doc/punk/_module_winlnk-0.1.0.tm.man | 50 ++ src/doc/punk/_module_zip-0.1.1.tm.man | 66 +++ .../_module_scriptwrap-0.1.0.tm.man | 38 +- src/doc/punk/nav/_module_fs-0.1.0.tm.man | 6 +- .../punk/repl/_module_codethread-0.1.0.tm.man | 8 +- .../files/_module_argparsingtest-0.1.0.tm.n | 4 +- .../man/files/_module_fauxlink-0.1.1.tm.n | 383 +++++++++++++ ...d-0.1.0.tm.n => _module_modpod-0.1.2.tm.n} | 4 +- .../man/files/_module_overtype-1.6.5.tm.n | 2 +- .../man/files/_module_poshinfo-0.1.0.tm.n | 11 +- .../man/files/_module_textblock-0.1.1.tm.n | 2 +- .../man/files/_module_textblock-0.1.2.tm.n | 512 ++++++++++++++++++ .../man/files/_module_tomlish-1.1.1.tm.n | 28 +- .../files/punk/_module_aliascore-0.1.0.tm.n | 6 +- .../man/files/punk/_module_ansi-0.1.1.tm.n | 12 + .../files/punk/_module_assertion-0.1.0.tm.n | 4 +- .../files/punk/_module_basictelnet-0.1.0.tm.n | 6 +- .../files/punk/_module_blockletter-0.1.0.tm.n | 329 +++++++++++ .../man/files/punk/_module_cesu-0.1.0.tm.n | 319 +++++++++++ .../files/punk/_module_experiment-0.1.0.tm.n | 4 +- .../man/files/punk/_module_island-0.1.0.tm.n | 4 +- .../man/files/punk/_module_lib-0.1.1.tm.n | 24 +- .../punk/_module_packagepreference-0.1.0.tm.n | 6 +- .../man/files/punk/_module_rest-0.1.0.tm.n | 323 +++++++++++ .../man/files/punk/_module_sshrun-0.1.0.tm.n | 4 +- .../man/files/punk/_module_trie-0.1.0.tm.n | 325 +++++++++++ .../man/files/punk/_module_uc-0.1.0.tm.n | 6 +- .../man/files/punk/_module_winlnk-0.1.0.tm.n | 343 ++++++++++++ .../_module_zip-0.1.1.tm.n} | 94 ++-- .../commandset/_module_scriptwrap-0.1.0.tm.n} | 83 ++- .../man/files/punk/nav/_module_fs-0.1.0.tm.n | 6 +- .../punk/repl/_module_codethread-0.1.0.tm.n | 8 +- src/embedded/man/index.n | 371 +++++++++++-- src/embedded/man/toc.n | 91 ++-- src/embedded/md/.doc/tocdoc | 73 +-- src/embedded/md/.idx | 2 +- src/embedded/md/.toc | 2 +- src/embedded/md/.xrf | 2 +- .../files/_module_argparsingtest-0.1.0.tm.md | 6 +- .../md/doc/files/_module_fauxlink-0.1.1.tm.md | 168 ++++++ ...0.1.0.tm.md => _module_modpod-0.1.2.tm.md} | 4 +- .../md/doc/files/_module_overtype-1.6.3.tm.md | 139 ----- .../md/doc/files/_module_overtype-1.6.4.tm.md | 139 ----- .../md/doc/files/_module_overtype-1.6.5.tm.md | 2 +- .../md/doc/files/_module_poshinfo-0.1.0.tm.md | 13 +- .../doc/files/_module_textblock-0.1.1.tm.md | 2 +- .../doc/files/_module_textblock-0.1.2.tm.md | 253 +++++++++ .../md/doc/files/_module_tomlish-1.1.1.tm.md | 72 ++- .../files/punk/_module_aliascore-0.1.0.tm.md | 8 +- .../doc/files/punk/_module_ansi-0.1.1.tm.md | 167 +++--- .../files/punk/_module_assertion-0.1.0.tm.md | 6 +- .../punk/_module_basictelnet-0.1.0.tm.md | 12 +- .../punk/_module_blockletter-0.1.0.tm.md | 98 ++++ .../doc/files/punk/_module_cesu-0.1.0.tm.md | 93 ++++ .../files/punk/_module_experiment-0.1.0.tm.md | 6 +- .../doc/files/punk/_module_island-0.1.0.tm.md | 6 +- .../md/doc/files/punk/_module_lib-0.1.1.tm.md | 123 +++-- .../_module_packagepreference-0.1.0.tm.md | 8 +- .../doc/files/punk/_module_rest-0.1.0.tm.md | 89 +++ .../doc/files/punk/_module_sshrun-0.1.0.tm.md | 6 +- .../doc/files/punk/_module_trie-0.1.0.tm.md | 96 ++++ .../md/doc/files/punk/_module_uc-0.1.0.tm.md | 11 +- .../doc/files/punk/_module_winlnk-0.1.0.tm.md | 116 ++++ .../md/doc/files/punk/_module_zip-0.1.1.tm.md | 125 +++++ .../commandset/_module_scriptwrap-0.1.0.tm.md | 108 ++++ .../doc/files/punk/nav/_module_fs-0.1.0.tm.md | 10 +- .../punk/repl/_module_codethread-0.1.0.tm.md | 10 +- src/embedded/md/doc/toc.md | 54 +- src/embedded/md/index.md | 86 ++- src/embedded/md/toc.md | 54 +- src/embedded/www/.doc/tocdoc | 73 +-- src/embedded/www/.idx | 2 +- src/embedded/www/.toc | 2 +- src/embedded/www/.xrf | 2 +- .../_module_argparsingtest-0.1.0.tm.html | 8 +- .../doc/files/_module_fauxlink-0.1.1.tm.html | 220 ++++++++ ...0.tm.html => _module_modpod-0.1.2.tm.html} | 4 +- .../doc/files/_module_overtype-1.6.5.tm.html | 2 +- .../doc/files/_module_poshinfo-0.1.0.tm.html | 17 +- .../doc/files/_module_textblock-0.1.1.tm.html | 2 +- .../doc/files/_module_textblock-0.1.2.tm.html | 279 ++++++++++ .../doc/files/_module_tomlish-1.1.1.tm.html | 52 +- .../punk/_module_aliascore-0.1.0.tm.html | 10 +- .../doc/files/punk/_module_ansi-0.1.1.tm.html | 163 +++--- .../punk/_module_assertion-0.1.0.tm.html | 8 +- .../punk/_module_basictelnet-0.1.0.tm.html | 10 +- .../punk/_module_blockletter-0.1.0.tm.html | 195 +++++++ .../doc/files/punk/_module_cesu-0.1.0.tm.html | 184 +++++++ .../punk/_module_experiment-0.1.0.tm.html | 8 +- .../files/punk/_module_island-0.1.0.tm.html | 8 +- .../doc/files/punk/_module_lib-0.1.1.tm.html | 110 ++-- .../_module_packagepreference-0.1.0.tm.html | 10 +- .../doc/files/punk/_module_rest-0.1.0.tm.html | 192 +++++++ .../files/punk/_module_sshrun-0.1.0.tm.html | 8 +- .../doc/files/punk/_module_trie-0.1.0.tm.html | 192 +++++++ .../doc/files/punk/_module_uc-0.1.0.tm.html | 10 +- .../_module_winlnk-0.1.0.tm.html} | 95 ++-- .../doc/files/punk/_module_zip-0.1.1.tm.html | 205 +++++++ .../_module_scriptwrap-0.1.0.tm.html} | 80 +-- .../files/punk/nav/_module_fs-0.1.0.tm.html | 8 +- .../repl/_module_codethread-0.1.0.tm.html | 10 +- src/embedded/www/doc/toc.html | 112 ++-- src/embedded/www/index.html | 237 +++++++- src/embedded/www/toc.html | 112 ++-- 128 files changed, 7441 insertions(+), 1383 deletions(-) create mode 100644 src/doc/_module_fauxlink-0.1.1.tm.man rename src/doc/{_module_modpod-0.1.0.tm.man => _module_modpod-0.1.2.tm.man} (96%) delete mode 100644 src/doc/_module_overtype-1.6.3.tm.man delete mode 100644 src/doc/_module_overtype-1.6.4.tm.man create mode 100644 src/doc/_module_textblock-0.1.2.tm.man create mode 100644 src/doc/punk/_module_blockletter-0.1.0.tm.man create mode 100644 src/doc/punk/_module_cesu-0.1.0.tm.man create mode 100644 src/doc/punk/_module_rest-0.1.0.tm.man create mode 100644 src/doc/punk/_module_trie-0.1.0.tm.man create mode 100644 src/doc/punk/_module_winlnk-0.1.0.tm.man create mode 100644 src/doc/punk/_module_zip-0.1.1.tm.man create mode 100644 src/embedded/man/files/_module_fauxlink-0.1.1.tm.n rename src/embedded/man/files/{_module_modpod-0.1.0.tm.n => _module_modpod-0.1.2.tm.n} (93%) create mode 100644 src/embedded/man/files/_module_textblock-0.1.2.tm.n create mode 100644 src/embedded/man/files/punk/_module_blockletter-0.1.0.tm.n create mode 100644 src/embedded/man/files/punk/_module_cesu-0.1.0.tm.n create mode 100644 src/embedded/man/files/punk/_module_rest-0.1.0.tm.n create mode 100644 src/embedded/man/files/punk/_module_trie-0.1.0.tm.n create mode 100644 src/embedded/man/files/punk/_module_winlnk-0.1.0.tm.n rename src/embedded/man/files/{_module_overtype-1.6.3.tm.n => punk/_module_zip-0.1.1.tm.n} (66%) rename src/embedded/man/files/{_module_overtype-1.6.4.tm.n => punk/mix/commandset/_module_scriptwrap-0.1.0.tm.n} (66%) create mode 100644 src/embedded/md/doc/files/_module_fauxlink-0.1.1.tm.md rename src/embedded/md/doc/files/{_module_modpod-0.1.0.tm.md => _module_modpod-0.1.2.tm.md} (88%) delete mode 100644 src/embedded/md/doc/files/_module_overtype-1.6.3.tm.md delete mode 100644 src/embedded/md/doc/files/_module_overtype-1.6.4.tm.md create mode 100644 src/embedded/md/doc/files/_module_textblock-0.1.2.tm.md create mode 100644 src/embedded/md/doc/files/punk/_module_blockletter-0.1.0.tm.md create mode 100644 src/embedded/md/doc/files/punk/_module_cesu-0.1.0.tm.md create mode 100644 src/embedded/md/doc/files/punk/_module_rest-0.1.0.tm.md create mode 100644 src/embedded/md/doc/files/punk/_module_trie-0.1.0.tm.md create mode 100644 src/embedded/md/doc/files/punk/_module_winlnk-0.1.0.tm.md create mode 100644 src/embedded/md/doc/files/punk/_module_zip-0.1.1.tm.md create mode 100644 src/embedded/md/doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md create mode 100644 src/embedded/www/doc/files/_module_fauxlink-0.1.1.tm.html rename src/embedded/www/doc/files/{_module_modpod-0.1.0.tm.html => _module_modpod-0.1.2.tm.html} (94%) create mode 100644 src/embedded/www/doc/files/_module_textblock-0.1.2.tm.html create mode 100644 src/embedded/www/doc/files/punk/_module_blockletter-0.1.0.tm.html create mode 100644 src/embedded/www/doc/files/punk/_module_cesu-0.1.0.tm.html create mode 100644 src/embedded/www/doc/files/punk/_module_rest-0.1.0.tm.html create mode 100644 src/embedded/www/doc/files/punk/_module_trie-0.1.0.tm.html rename src/embedded/www/doc/files/{_module_overtype-1.6.4.tm.html => punk/_module_winlnk-0.1.0.tm.html} (50%) create mode 100644 src/embedded/www/doc/files/punk/_module_zip-0.1.1.tm.html rename src/embedded/www/doc/files/{_module_overtype-1.6.3.tm.html => punk/mix/commandset/_module_scriptwrap-0.1.0.tm.html} (50%) diff --git a/src/doc/_module_argparsingtest-0.1.0.tm.man b/src/doc/_module_argparsingtest-0.1.0.tm.man index 41ba04dd..ba815e3c 100644 --- a/src/doc/_module_argparsingtest-0.1.0.tm.man +++ b/src/doc/_module_argparsingtest-0.1.0.tm.man @@ -1,7 +1,7 @@ [comment {--- punk::docgen generated from inline doctools comments ---}] [comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] [comment {--- punk::docgen overwrites this file ---}] -[manpage_begin shellspy_module_argparsingtest 0 0.1.0] +[manpage_begin punkshell_module_argparsingtest 0 0.1.0] [copyright "2024"] [titledesc {Module API}] [comment {-- Name section and table of contents description --}] [moddesc {-}] [comment {-- Description at end of page heading --}] diff --git a/src/doc/_module_fauxlink-0.1.1.tm.man b/src/doc/_module_fauxlink-0.1.1.tm.man new file mode 100644 index 00000000..b74f129d --- /dev/null +++ b/src/doc/_module_fauxlink-0.1.1.tm.man @@ -0,0 +1,71 @@ +[comment {--- punk::docgen generated from inline doctools comments ---}] +[comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] +[comment {--- punk::docgen overwrites this file ---}] +[manpage_begin fauxlink_module_fauxlink 0 0.1.1] +[copyright "2024"] +[titledesc {faux link application shortcuts}] [comment {-- Name section and table of contents description --}] +[moddesc {fauxlink .fxlnk}] [comment {-- Description at end of page heading --}] +[require fauxlink] +[keywords symlink faux fake shortcut toml] +[description] +[para] A cross platform shortcut/symlink alternative. +[para] Unapologetically ugly - but practical in certain circumstances. +[para] A solution is required for application-driven filesystem links that survives cross platform moves as well as +[para] archiving and packaging systems. +[para] The target is specified in a minimally-encoded form in the filename itself - but still human readable. +[para] format of name #.fxlnk +[para] where can be empty - then the effective nominal name is the tail of the +[para] The + symbol substitutes for forward-slashes. +[para] Other chars can be encoded using url-like encoding - (but only up to %7E !) +[para] We deliberately treat higher % sequences literally. +[para] This means actual uri::urn encoded unicode sequences (e.g %E2%99%A5 [lb]heart[rb]) can remain literal for linking to urls. +[para] e.g if an actual + or # is required in a filename or path segment they can be encoded as %2B & %23 +[para] e.g a link to a file file#A.txt in parent dir could be: +[para] file%23A.txt#..+file%23A.txt.fxlnk +[para] or equivalently (but obviously affecting sorting) #..+file%23A.txt.fxlnk +[para] The can be unrelated to the actual target +[para] e.g datafile.dat#..+file%23A.txt.fxlnk +[para] This system has no filesystem support - and must be completely application driven. +[para] This can be useful for example in application test packages which may be tarred or zipped and moved cross platform. +[para] The target being fully specified in the name means the file doesn't have to be read for the target to be determined +[para] Extensions to behaviour should be added in the file as text data in Toml format, +[para] with custom data being under a single application-chosen table name +[para] The toplevel Toml table [lb]fauxlink[rb] is reserved for core extensions to this system. +[para] Aside from the 2 used for delimiting (+ #) +[para] certain characters which might normally be allowed in filesystems are required to be encoded +[para] e.g space and tab are required to be %20 %09 +[para] Others that require encoding are: * ? \ / | : ; " < > +[para] The nul character in raw form, when detected, is always mapped away to the empty string - as very few filesystems support it. +[para] Control characters and other punctuation is optional to encode. +[para] Generally utf-8 should be used where possible and unicode characters can often be left unencoded on modern systems. +[para] Where encoding of unicode is desired in the nominalname,encodedtarget,tag or comment portions it can be specified as %UXXXXXXXX +[para] There must be between 1 and 8 X digits following the %U. Interpretation of chars following %U stops at the first non-hex character. +[para] This means %Utest would not get any translation as there were no hex digits so it would come out as %Utest + + ++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +[section Overview] +[para] overview of fauxlink +[subsection Concepts] +[para] - +[subsection dependencies] +[para] packages used by fauxlink +[list_begin itemized] +[item] [package {Tcl 8.6-}] +[list_end] +[section API] +[subsection {Namespace fauxlink::class}] +[para] class definitions +[list_begin enumerated] +[list_end] [comment {--- end class enumeration ---}] +[subsection {Namespace fauxlink}] +[para] Core API functions for fauxlink +[list_begin definitions] +[list_end] [comment {--- end definitions namespace fauxlink ---}] +[subsection {Namespace fauxlink::lib}] +[para] Secondary functions that are part of the API +[list_begin definitions] +[list_end] [comment {--- end definitions namespace fauxlink::lib ---}] +[section Internal] +[subsection {Namespace fauxlink::system}] +[para] Internal functions that are not part of the API +[manpage_end] diff --git a/src/doc/_module_modpod-0.1.0.tm.man b/src/doc/_module_modpod-0.1.2.tm.man similarity index 96% rename from src/doc/_module_modpod-0.1.0.tm.man rename to src/doc/_module_modpod-0.1.2.tm.man index c39fd80d..e7644947 100644 --- a/src/doc/_module_modpod-0.1.0.tm.man +++ b/src/doc/_module_modpod-0.1.2.tm.man @@ -1,7 +1,7 @@ [comment {--- punk::docgen generated from inline doctools comments ---}] [comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] [comment {--- punk::docgen overwrites this file ---}] -[manpage_begin modpod_module_modpod 0 0.1.0] +[manpage_begin modpod_module_modpod 0 0.1.2] [copyright "2024"] [titledesc {Module API}] [comment {-- Name section and table of contents description --}] [moddesc {-}] [comment {-- Description at end of page heading --}] diff --git a/src/doc/_module_overtype-1.6.3.tm.man b/src/doc/_module_overtype-1.6.3.tm.man deleted file mode 100644 index 212e5371..00000000 --- a/src/doc/_module_overtype-1.6.3.tm.man +++ /dev/null @@ -1,49 +0,0 @@ -[comment {--- punk::docgen generated from inline doctools comments ---}] -[comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] -[comment {--- punk::docgen overwrites this file ---}] -[manpage_begin overtype_module_overtype 0 1.6.3] -[copyright "2024"] -[titledesc {overtype text layout - ansi aware}] [comment {-- Name section and table of contents description --}] -[moddesc {overtype text layout}] [comment {-- Description at end of page heading --}] -[require overtype] -[keywords module text ansi] -[description] -[para] - -[section Overview] -[para] overview of overtype -[subsection Concepts] -[para] - -[subsection dependencies] -[para] packages used by overtype -[list_begin itemized] -[item] [package {Tcl 8.6}] -[item] [package textutil] -[item] [package punk::ansi] -[para] - required to detect, split, strip and calculate lengths of text possibly containing ansi codes -[item] [package punk::char] -[para] - box drawing - and also unicode character width determination for proper layout of text with double-column-width chars -[list_end] -[section API] -[subsection {Namespace overtype}] -[para] Core API functions for overtype -[list_begin definitions] -[call [fun overtype::renderspace] [arg args] ] -[para] usage: ?-transparent [lb]0|1[rb]? ?-overflow [lb]1|0[rb]? ?-ellipsis [lb]1|0[rb]? ?-ellipsistext ...? undertext overtext -[call [fun overtype::renderline] [arg args] ] -[para] renderline is the core engine for overtype string processing (frames & textblocks), and the raw mode commandline repl for the Tcl Punk Shell -[para] It is also a central part of an ansi (micro) virtual terminal-emulator of sorts -[para] This system does a half decent job at rendering 90's ANSI art to manipulable colour text blocks that can be joined & framed for layout display within a unix or windows terminal -[para] Renderline helps maintain ANSI text styling reset/replay codes so that the styling of one block doesn't affect another. -[para] Calling on the punk::ansi library - it can coalesce codes to keep the size down. -[para] It is a giant mess of doing exactly what common wisdom says not to do... lots at once. -[para] renderline is part of the Unicode and ANSI aware Overtype system which 'renders' a block of text onto a static underlay -[para] The underlay is generally expected to be an ordered set of lines or a rectangular text block analogous to a terminal screen - but it can also be ragged in line length, or just blank. -[para] The overlay couuld be similar - in which case it may often be used to overwrite a column or section of the underlay. -[para] The overlay could however be a sequence of ANSI-laden text that jumps all over the place. - -[para] renderline itself only deals with a single line - or sometimes a single character. It is generally called from a loop that does further terminal-like or textblock processing. -[para] By suppyling the -info 1 option - it can return various fields indicating the state of the render. -[para] The main 3 are the result, overflow_right, and unapplied. -[para] Renderline handles cursor movements from either keystrokes or ANSI sequences but for a full system the aforementioned loop will need to be in place to manage the set of lines under manipulation. -[list_end] [comment {--- end definitions namespace overtype ---}] -[manpage_end] diff --git a/src/doc/_module_overtype-1.6.4.tm.man b/src/doc/_module_overtype-1.6.4.tm.man deleted file mode 100644 index fb7346b2..00000000 --- a/src/doc/_module_overtype-1.6.4.tm.man +++ /dev/null @@ -1,49 +0,0 @@ -[comment {--- punk::docgen generated from inline doctools comments ---}] -[comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] -[comment {--- punk::docgen overwrites this file ---}] -[manpage_begin overtype_module_overtype 0 1.6.4] -[copyright "2024"] -[titledesc {overtype text layout - ansi aware}] [comment {-- Name section and table of contents description --}] -[moddesc {overtype text layout}] [comment {-- Description at end of page heading --}] -[require overtype] -[keywords module text ansi] -[description] -[para] - -[section Overview] -[para] overview of overtype -[subsection Concepts] -[para] - -[subsection dependencies] -[para] packages used by overtype -[list_begin itemized] -[item] [package {Tcl 8.6}] -[item] [package textutil] -[item] [package punk::ansi] -[para] - required to detect, split, strip and calculate lengths of text possibly containing ansi codes -[item] [package punk::char] -[para] - box drawing - and also unicode character width determination for proper layout of text with double-column-width chars -[list_end] -[section API] -[subsection {Namespace overtype}] -[para] Core API functions for overtype -[list_begin definitions] -[call [fun overtype::renderspace] [arg args] ] -[para] usage: ?-transparent [lb]0|1[rb]? ?-overflow [lb]1|0[rb]? ?-ellipsis [lb]1|0[rb]? ?-ellipsistext ...? undertext overtext -[call [fun overtype::renderline] [arg args] ] -[para] renderline is the core engine for overtype string processing (frames & textblocks), and the raw mode commandline repl for the Tcl Punk Shell -[para] It is also a central part of an ansi (micro) virtual terminal-emulator of sorts -[para] This system does a half decent job at rendering 90's ANSI art to manipulable colour text blocks that can be joined & framed for layout display within a unix or windows terminal -[para] Renderline helps maintain ANSI text styling reset/replay codes so that the styling of one block doesn't affect another. -[para] Calling on the punk::ansi library - it can coalesce codes to keep the size down. -[para] It is a giant mess of doing exactly what common wisdom says not to do... lots at once. -[para] renderline is part of the Unicode and ANSI aware Overtype system which 'renders' a block of text onto a static underlay -[para] The underlay is generally expected to be an ordered set of lines or a rectangular text block analogous to a terminal screen - but it can also be ragged in line length, or just blank. -[para] The overlay couuld be similar - in which case it may often be used to overwrite a column or section of the underlay. -[para] The overlay could however be a sequence of ANSI-laden text that jumps all over the place. - -[para] renderline itself only deals with a single line - or sometimes a single character. It is generally called from a loop that does further terminal-like or textblock processing. -[para] By suppyling the -info 1 option - it can return various fields indicating the state of the render. -[para] The main 3 are the result, overflow_right, and unapplied. -[para] Renderline handles cursor movements from either keystrokes or ANSI sequences but for a full system the aforementioned loop will need to be in place to manage the set of lines under manipulation. -[list_end] [comment {--- end definitions namespace overtype ---}] -[manpage_end] diff --git a/src/doc/_module_overtype-1.6.5.tm.man b/src/doc/_module_overtype-1.6.5.tm.man index 92752013..166da531 100644 --- a/src/doc/_module_overtype-1.6.5.tm.man +++ b/src/doc/_module_overtype-1.6.5.tm.man @@ -28,7 +28,7 @@ [para] Core API functions for overtype [list_begin definitions] [call [fun overtype::renderspace] [arg args] ] -[para] usage: ?-transparent [lb]0|1[rb]? ?-overflow [lb]1|0[rb]? ?-ellipsis [lb]1|0[rb]? ?-ellipsistext ...? undertext overtext +[para] usage: ?-transparent [lb]0|1[rb]? ?-expand_right [lb]1|0[rb]? ?-ellipsis [lb]1|0[rb]? ?-ellipsistext ...? undertext overtext [call [fun overtype::renderline] [arg args] ] [para] renderline is the core engine for overtype string processing (frames & textblocks), and the raw mode commandline repl for the Tcl Punk Shell [para] It is also a central part of an ansi (micro) virtual terminal-emulator of sorts diff --git a/src/doc/_module_poshinfo-0.1.0.tm.man b/src/doc/_module_poshinfo-0.1.0.tm.man index fc47b6b7..c7946a6c 100644 --- a/src/doc/_module_poshinfo-0.1.0.tm.man +++ b/src/doc/_module_poshinfo-0.1.0.tm.man @@ -1,12 +1,12 @@ [comment {--- punk::docgen generated from inline doctools comments ---}] [comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] [comment {--- punk::docgen overwrites this file ---}] -[manpage_begin shellspy_module_poshinfo 0 0.1.0] +[manpage_begin punkshell_module_poshinfo 0 0.1.0] [copyright "2024"] -[titledesc {Module API}] [comment {-- Name section and table of contents description --}] -[moddesc {-}] [comment {-- Description at end of page heading --}] +[titledesc {poshinfo prompt theme tool}] [comment {-- Name section and table of contents description --}] +[moddesc {POSH-related prompt tool}] [comment {-- Description at end of page heading --}] [require poshinfo] -[keywords module] +[keywords module terminal console theme prompt {prompt theme} POSH] [description] [para] - [section Overview] @@ -23,12 +23,8 @@ [section API] [subsection {Namespace poshinfo::class}] [para] class definitions -if {[tcl::info::commands [tcl::namespace::current]::interface_sample1] eq ""} { [list_begin enumerated] [list_end] [comment {--- end class enumeration ---}] -} -} - ++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ [subsection {Namespace poshinfo}] [para] Core API functions for poshinfo [list_begin definitions] @@ -38,7 +34,6 @@ if {[tcl::info::commands [tcl::namespace::current]::interface_sample1] eq ""} { [list_begin definitions] [list_end] [comment {--- end definitions namespace poshinfo::lib ---}] [section Internal] -tcl::namespace::eval poshinfo::system { [subsection {Namespace poshinfo::system}] [para] Internal functions that are not part of the API [manpage_end] diff --git a/src/doc/_module_textblock-0.1.1.tm.man b/src/doc/_module_textblock-0.1.1.tm.man index 2dcf2ab0..08d7a07d 100644 --- a/src/doc/_module_textblock-0.1.1.tm.man +++ b/src/doc/_module_textblock-0.1.1.tm.man @@ -32,7 +32,7 @@ [item] [para] [emph {handler_classes}] [list_begin enumerated] -[enum] CLASS [class interface_caphandler.registry] +[enum] CLASS [class textblock::class::table] [list_begin definitions] [para] [emph METHODS] [call class::table [method constructor] [arg args]] diff --git a/src/doc/_module_textblock-0.1.2.tm.man b/src/doc/_module_textblock-0.1.2.tm.man new file mode 100644 index 00000000..72c1c40e --- /dev/null +++ b/src/doc/_module_textblock-0.1.2.tm.man @@ -0,0 +1,120 @@ +[comment {--- punk::docgen generated from inline doctools comments ---}] +[comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] +[comment {--- punk::docgen overwrites this file ---}] +[manpage_begin punkshell_module_textblock 0 0.1.2] +[copyright "2024"] +[titledesc {punk textblock functions}] [comment {-- Name section and table of contents description --}] +[moddesc {punk textblock}] [comment {-- Description at end of page heading --}] +[require textblock] +[keywords module ansi text layout colour table frame console terminal] +[description] +[para] Ansi-aware terminal textblock manipulation +[section Overview] +[para] overview of textblock +[subsection Concepts] +[para] +[subsection dependencies] +[para] packages used by textblock +[list_begin itemized] +[item] [package {Tcl 8.6-}] +[item] [package {punk::args}] +[item] [package {punk::char}] +[item] [package {punk::ansi}] +[item] [package {punk::lib}] +[item] [package {overtype}] +[item] [package {term::ansi::code::macros}] +[item] [package {textutil}] +[list_end] +[section API] +[subsection {Namespace textblock::class}] +[para] class definitions +[list_begin itemized] [comment {- textblock::class groupings -}] + [item] + [para] [emph {handler_classes}] + [list_begin enumerated] +[enum] CLASS [class textblock::class::table] +[list_begin definitions] +[para] Create a table suitable for terminal output with various border styles. +[para] The table can contain multiline cells and ANSI colour and text style attributes. +[para] Multiple header rows can be configured. +[para] Header rows can span columns - data rows cannot. +[para] The restriction on data rows is to maintain compatibility of the data with a Tcl matrix command +[para] (see get_matrix command) +[para] Both header and data cells can have various text and blockalignments configured. + [para] [emph METHODS] +[call class::table [method constructor] [arg args]] +[para] TODO - document the many options +[call class::table [method configure] [arg args]] +[para] get or set various table-level properties +[call class::table [method printmatrix] [arg matrix]] +[para] clear all table rows and print a matrix into the table +[para] The rowxcolumn structure must match +[call class::table [method as_matrix] [arg ?cmd?]] +[para] return a struct::matrix command representing the data portion of the table. +[call class::table [method add_column] [arg args]] +[call class::table [method column_count]] +[para] return the number of columns +[call class::table [method configure_column] [arg index_expression] [arg args]] +[para] - undocumented +[call class::table [method header_count]] +[para] return the number of header rows +[call class::table [method header_height] [arg header_index]] +[para] return the height of a header as the number of content-lines +[call class::table [method header_colspans]] +[para] Show the colspans configured for all headers +[call class::table [method configure_header]] +[para] - undocumented +[call class::table [method add_row]\ + [arg valuelist]\ + [opt "[option -minheight] [arg int_minheight]"]\ + [opt "[option -maxheight] [arg int_maxheight]"]\ + [opt "[option -ansibase] [arg ansicode]"]\ +] +[call class::table [method configure_row]\ + [arg index_expression]\ + [opt "[option -minheight] [arg int_minheight]"]\ + [opt "[option -maxheight] [arg int_maxheight]"]\ + [opt "[option -ansibase] [arg ansicode]"]\ +] +[call class::table [method row_count]] +[para] return the number of data rows in the table. +[call class::table [method row_clear]] +[para] Remove all rows without resetting column data. +[para] When adding new rows the number of entries will need to match the existing column count. +[call class::table [method clear]] +[para] Remove all row and column data. +[para] If a subsequent call to add_row is made it can contain any number of values. +[para] Further calls to add_row will need to contain the same number of values +[para] as the first call unless default values have been set for the missing columns (review - in flux). +[call class::table [method get_column_cells_by_index] [arg index_expression]] +[para] Return a dict with keys 'headers' and 'cells' giving column header and data values +[call class::table [method get_column_values_by_index] [arg index_expression]] +[para] List the cell values of a column from the data area only (no header values) +[call class::table [method debug]] +[para] display lots of debug information about how the table is constructed. +[call class::table [method column_width] [arg index_expression]] +[para] inner width of column ie the available cell-width without borders/separators +[call class::table [method column_width]] +[para] ordered list of column widths (inner widths) +[call class::table [method width]] +[para] width of the table including borders and separators +[para] calculate width based on assumption frame verticals are 1 screen-column wide +[para] (review - consider possibility of custom unicode double-wide frame?) +[call class::table [method spangroups]] +[para] return a dict keyed by column-index showing advanced span information +[para] (debug tool) +[call class::table [method print]] +[para] Return the table as text suitable for console display +[call class::table [method print_bodymatrix]] +[para] output the matrix string corresponding to the body data using the matrix 2string format +[para] this will be a table without borders,headers,title etc and will exclude additional ANSI applied due to table, row or column settings. +[para] If the original cell data itself contains ANSI - the output will still contain those ansi codes. + +[list_end] + [list_end] [comment {- end enumeration provider_classes }] +[list_end] [comment {- end itemized list textblock::class groupings -}] + Already uniform blocks will join faster than textblock::join, and ragged blocks will join in a ragged manner +" + Already uniform blocks will join faster than textblock::join, and ragged blocks will join in a ragged manner +" +[manpage_end] diff --git a/src/doc/_module_tomlish-1.1.1.tm.man b/src/doc/_module_tomlish-1.1.1.tm.man index 9e8b3162..aea1696e 100644 --- a/src/doc/_module_tomlish-1.1.1.tm.man +++ b/src/doc/_module_tomlish-1.1.1.tm.man @@ -3,12 +3,20 @@ [comment {--- punk::docgen overwrites this file ---}] [manpage_begin tomlish_module_tomlish 0 1.1.1] [copyright "2024"] -[titledesc {Module API}] [comment {-- Name section and table of contents description --}] -[moddesc {-}] [comment {-- Description at end of page heading --}] +[titledesc {tomlish toml parser}] [comment {-- Name section and table of contents description --}] +[moddesc {tomlish}] [comment {-- Description at end of page heading --}] [require tomlish] -[keywords module] +[keywords module parsing toml configuration] [description] -[para] - +[para] tomlish is an intermediate representation of toml data in a tree structure (tagged lists representing type information) +[para] The design goals are for tomlish to be whitespace and comment preserving ie byte-for byte preservation during roundtrips from toml to tomlish and back to toml +[para] The tomlish representation can then be converted to a Tcl dict structure or to other formats such as json, +[para] although these other formats are generally unlikely to retain whitespace or comments +[para] A further goal is to allow at least a useful subset of in-place editing operations which also preserve whitespace and comments. +[para] e.g leaf key value editing, and table reordering/sorting, key-renaming at any level, key insertions/deletions +[para] The API for editing (tomldoc object?) may require explicit setting of type if accessing an existing key +[para] e.g setting a key that already exists and is a different type (especially if nested structure such as a table or array) +[para] will need a -type option (-force ?) to force overriding with another type such as an int. [section Overview] [para] overview of tomlish [subsection Concepts] @@ -20,10 +28,6 @@ [item] [package {struct::stack}] [list_end] [section API] -[subsection {Namespace tomlish::class}] -[para] class definitions -[list_begin enumerated] -[list_end] [comment {--- end class enumeration ---}] [subsection {Namespace tomlish}] [para] Core API functions for tomlish [list_begin definitions] diff --git a/src/doc/punk/_module_aliascore-0.1.0.tm.man b/src/doc/punk/_module_aliascore-0.1.0.tm.man index afda4d95..1a6b9ab0 100644 --- a/src/doc/punk/_module_aliascore-0.1.0.tm.man +++ b/src/doc/punk/_module_aliascore-0.1.0.tm.man @@ -1,12 +1,12 @@ [comment {--- punk::docgen generated from inline doctools comments ---}] [comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] [comment {--- punk::docgen overwrites this file ---}] -[manpage_begin shellspy_module_punk::aliascore 0 0.1.0] +[manpage_begin punkshell_module_punk::aliascore 0 0.1.0] [copyright "2024"] -[titledesc {Module API}] [comment {-- Name section and table of contents description --}] +[titledesc {punkshell command aliases}] [comment {-- Name section and table of contents description --}] [moddesc {-}] [comment {-- Description at end of page heading --}] [require punk::aliascore] -[keywords module] +[keywords module alias] [description] [para] - [section Overview] diff --git a/src/doc/punk/_module_ansi-0.1.1.tm.man b/src/doc/punk/_module_ansi-0.1.1.tm.man index e0c8e14f..f91271c0 100644 --- a/src/doc/punk/_module_ansi-0.1.1.tm.man +++ b/src/doc/punk/_module_ansi-0.1.1.tm.man @@ -74,6 +74,7 @@ [para]The following example shows how to do this manually, emitting the string blah at screen position 10,10 and emitting DONE back at the line we started: [para][example {punk::ansi::move_emit 10 10 blah {*}[punk::console::get_cursor_pos_list] DONE}] [para]A string created by any move_emit_return for punk::ansi would not behave in an intuitive manner compared to other punk::ansi move functions - so is deliberately omitted. +[call [fun move_emitblock] [arg row] [arg col] [arg textblock]] [call [fun move_forward] [arg n]] [call [fun move_back] [arg n]] [call [fun move_up] [arg n]] @@ -135,6 +136,9 @@ tput rmam [call [fun ansistrip] [arg text] ] [para]Return a string with ansi codes stripped out [para]Alternate graphics chars are replaced with modern unicode equivalents (e.g boxdrawing glyphs) +[call [fun ansistrip] [arg text] ] +[para]Return a string with ansi codes stripped out +[para]Alternate graphics chars are replaced with modern unicode equivalents (e.g boxdrawing glyphs) [call [fun ansistripraw] [arg text] ] [para]Return a string with ansi codes stripped out [para]Alternate graphics modes will be stripped rather than converted to unicode - exposing the raw ascii characters as they appear without graphics mode. diff --git a/src/doc/punk/_module_assertion-0.1.0.tm.man b/src/doc/punk/_module_assertion-0.1.0.tm.man index bf37675b..a51e115d 100644 --- a/src/doc/punk/_module_assertion-0.1.0.tm.man +++ b/src/doc/punk/_module_assertion-0.1.0.tm.man @@ -1,7 +1,7 @@ [comment {--- punk::docgen generated from inline doctools comments ---}] [comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] [comment {--- punk::docgen overwrites this file ---}] -[manpage_begin shellspy_module_punk::assertion 0 0.1.0] +[manpage_begin punkshell_module_punk::assertion 0 0.1.0] [copyright "2024"] [titledesc {assertion alternative to control::assert}] [comment {-- Name section and table of contents description --}] [moddesc {per-namespace assertions with }] [comment {-- Description at end of page heading --}] diff --git a/src/doc/punk/_module_basictelnet-0.1.0.tm.man b/src/doc/punk/_module_basictelnet-0.1.0.tm.man index b472f3c2..44506db7 100644 --- a/src/doc/punk/_module_basictelnet-0.1.0.tm.man +++ b/src/doc/punk/_module_basictelnet-0.1.0.tm.man @@ -1,12 +1,12 @@ [comment {--- punk::docgen generated from inline doctools comments ---}] [comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] [comment {--- punk::docgen overwrites this file ---}] -[manpage_begin shellspy_module_punk::basictelnet 0 0.1.0] +[manpage_begin punkshell::basictelnet 0 0.1.0] [copyright "2024"] [titledesc {basic telnet client - DKF/Wiki}] [comment {-- Name section and table of contents description --}] [moddesc {basic telnet client}] [comment {-- Description at end of page heading --}] [require punk::basictelnet] -[keywords module] +[keywords module telnet protocol console terminal] [description] [para] see https://wiki.tcl-lang.org/page/Tcl+Telnet [section Overview] diff --git a/src/doc/punk/_module_blockletter-0.1.0.tm.man b/src/doc/punk/_module_blockletter-0.1.0.tm.man new file mode 100644 index 00000000..8e3f974e --- /dev/null +++ b/src/doc/punk/_module_blockletter-0.1.0.tm.man @@ -0,0 +1,45 @@ +[comment {--- punk::docgen generated from inline doctools comments ---}] +[comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] +[comment {--- punk::docgen overwrites this file ---}] +[manpage_begin punkshell_module_punk::blockletter 0 0.1.0] +[copyright "2024"] +[titledesc {punk::blockletter frame-based large lettering test/logo}] [comment {-- Name section and table of contents description --}] +[moddesc {-}] [comment {-- Description at end of page heading --}] +[require punk::blockletter] +[keywords module] +[description] +[para] This is primarily designed to test large lettering using the block2 frametype which requires the right font support +[para] More reasonably sized block-lettering could be obtained using unicode half-blocks instead - but that doesn't allow the frame outline effect that block2 gives. +[para] Individual blocks have a minimum width of 4 columns and a minimum height of 2 rows (smallest element that can be fully framed) +[section Overview] +[para] overview of punk::blockletter +[subsection Concepts] +[para] - +[subsection dependencies] +[para] packages used by punk::blockletter +[list_begin itemized] +[item] [package {Tcl 8.6}] +[item] [package {textblock}] +[list_end] +[section API] +[subsection {Namespace punk::blockletter::class}] +[para] class definitions +if {[tcl::info::commands [tcl::namespace::current]::interface_sample1] eq ""} { +[list_begin enumerated] +[list_end] [comment {--- end class enumeration ---}] +} +} + ++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +[subsection {Namespace punk::blockletter}] +[para] Core API functions for punk::blockletter +[list_begin definitions] +[list_end] [comment {--- end definitions namespace punk::blockletter ---}] +[subsection {Namespace punk::blockletter::lib}] +[para] Secondary functions that are part of the API +[list_begin definitions] +[list_end] [comment {--- end definitions namespace punk::blockletter::lib ---}] +[section Internal] +tcl::namespace::eval punk::blockletter::system { +[subsection {Namespace punk::blockletter::system}] +[para] Internal functions that are not part of the API +[manpage_end] diff --git a/src/doc/punk/_module_cesu-0.1.0.tm.man b/src/doc/punk/_module_cesu-0.1.0.tm.man new file mode 100644 index 00000000..f8faeb20 --- /dev/null +++ b/src/doc/punk/_module_cesu-0.1.0.tm.man @@ -0,0 +1,36 @@ +[comment {--- punk::docgen generated from inline doctools comments ---}] +[comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] +[comment {--- punk::docgen overwrites this file ---}] +[manpage_begin punkshell_module_punk::cesu 0 0.1.0] +[copyright "2024"] +[titledesc {CESU compatibility ehcoding scheme for utf-16: 8-Bit (CESU-8) ??}] [comment {-- Name section and table of contents description --}] +[moddesc {CESU experimental}] [comment {-- Description at end of page heading --}] +[require punk::cesu] +[keywords module cesu encoding compatibility experimental unofficial] +[description] +[para] experimental +[section Overview] +[para] overview of punk::cesu +[subsection Concepts] +[para] cesu-8 may be mistaken for utf-8 if no supplementary chars present. +[para] see: https://www.unicode.org/reports/tr26/tr26-4.html +[para] Particulary note discouragement of use especially in external interchange. +[subsection dependencies] +[para] packages used by punk::cesu +[list_begin itemized] +[item] [package {Tcl 8.6}] +[list_end] +[section API] +[subsection {Namespace punk::cesu}] +[para] Core API functions for punk::cesu +[list_begin definitions] +[list_end] [comment {--- end definitions namespace punk::cesu ---}] +[subsection {Namespace punk::cesu::lib}] +[para] Secondary functions that are part of the API +[list_begin definitions] +[list_end] [comment {--- end definitions namespace punk::cesu::lib ---}] +[section Internal] +tcl::namespace::eval punk::cesu::system { +[subsection {Namespace punk::cesu::system}] +[para] Internal functions that are not part of the API +[manpage_end] diff --git a/src/doc/punk/_module_experiment-0.1.0.tm.man b/src/doc/punk/_module_experiment-0.1.0.tm.man index 1474fa6e..74410f27 100644 --- a/src/doc/punk/_module_experiment-0.1.0.tm.man +++ b/src/doc/punk/_module_experiment-0.1.0.tm.man @@ -1,7 +1,7 @@ [comment {--- punk::docgen generated from inline doctools comments ---}] [comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] [comment {--- punk::docgen overwrites this file ---}] -[manpage_begin shellspy_module_punk::experiment 0 0.1.0] +[manpage_begin punkshell_module_punk::experiment 0 0.1.0] [copyright "2024"] [titledesc {Module API}] [comment {-- Name section and table of contents description --}] [moddesc {-}] [comment {-- Description at end of page heading --}] diff --git a/src/doc/punk/_module_island-0.1.0.tm.man b/src/doc/punk/_module_island-0.1.0.tm.man index 9ae6e9f9..c81bfb59 100644 --- a/src/doc/punk/_module_island-0.1.0.tm.man +++ b/src/doc/punk/_module_island-0.1.0.tm.man @@ -1,7 +1,7 @@ [comment {--- punk::docgen generated from inline doctools comments ---}] [comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] [comment {--- punk::docgen overwrites this file ---}] -[manpage_begin shellspy_module_punk::island 0 0.1.0] +[manpage_begin punkshell_module_punk::island 0 0.1.0] [copyright "2024"] [titledesc {filesystem islands for safe interps}] [comment {-- Name section and table of contents description --}] [moddesc {punk::island for safe interps}] [comment {-- Description at end of page heading --}] diff --git a/src/doc/punk/_module_lib-0.1.1.tm.man b/src/doc/punk/_module_lib-0.1.1.tm.man index 7674e605..3ed85582 100644 --- a/src/doc/punk/_module_lib-0.1.1.tm.man +++ b/src/doc/punk/_module_lib-0.1.1.tm.man @@ -52,11 +52,20 @@ [para]Sometimes the actual integer index is desired. [para]We want to resolve the index used, without passing arbitrary expressions into the 'expr' function - which could have security risks. [para]lindex_resolve will parse the index expression and return: -[para] a) -2 if the supplied index expression is below the lower bound for the supplied list. (< 0) -[para] b) -1 if the supplied index expression is above the upper bound for the supplied list. (> end) +[para] a) -3 if the supplied index expression is below the lower bound for the supplied list. (< 0) +[para] b) -2 if the supplied index expression is above the upper bound for the supplied list. (> end) +[para] We don't return -1 - as the similar function lindex_resolve_basic uses this to denote out of range at either end of the list [para]Otherwise it will return an integer corresponding to the position in the list. [para]This is in stark contrast to Tcl list function indices which will return empty strings for out or bounds indices, or in the case of lrange, return results anyway. [para]Like Tcl list commands - it will produce an error if the form of the index is not acceptable +[para]For empty lists, end and end+x indices are considered to be out of bounds on the upper side - thus returning -2 +[call [fun lindex_resolve_basic] [arg list] [arg index]] +[para] Accepts index of the forms accepted by Tcl's list commands. (e.g compound indices such as 3+1 end-2) +[para] returns -1 for out of range at either end, or a valid integer index +[para] Unlike lindex_resolve; lindex_resolve_basic can't determine if an out of range index was out of range at the lower or upper bound +[para] This is only likely to be faster than average over lindex_resolve for Tcl which has the builtin lseq command +[para] The performance advantage is more likely to be present when using compound indexes such as $x+1 or end-1 +[para] For pure integer indices the performance should be equivalent [call [fun K] [arg x] [arg y]] [para]The K-combinator function - returns the first argument, x and discards y [para]see [uri https://wiki.tcl-lang.org/page/K] @@ -123,13 +132,13 @@ but has the disadvantage of being slower for 'small' numbers and using more memo [para]For an odd value of x - this will always return x [call [fun gcd] [arg n] [arg m]] [para]Return the greatest common divisor of m and n -[para]Straight from Lars Hellström's math::numtheory library in Tcllib +[para]Straight from Lars Hellström's math::numtheory library in Tcllib [para]Graphical use: [para]An a by b rectangle can be covered with square tiles of side-length c, [para]only if c is a common divisor of a and b [call [fun gcd] [arg n] [arg m]] [para]Return the lowest common multiple of m and n -[para]Straight from Lars Hellström's math::numtheory library in Tcllib +[para]Straight from Lars Hellström's math::numtheory library in Tcllib [para] [call [fun commonDivisors] [arg x] [arg y]] [para]Return a list of all the common factors of x and y diff --git a/src/doc/punk/_module_packagepreference-0.1.0.tm.man b/src/doc/punk/_module_packagepreference-0.1.0.tm.man index f532ed97..d108dec8 100644 --- a/src/doc/punk/_module_packagepreference-0.1.0.tm.man +++ b/src/doc/punk/_module_packagepreference-0.1.0.tm.man @@ -1,12 +1,12 @@ [comment {--- punk::docgen generated from inline doctools comments ---}] [comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] [comment {--- punk::docgen overwrites this file ---}] -[manpage_begin shellspy_module_punk::packagepreference 0 0.1.0] +[manpage_begin punkshell_module_punk::packagepreference 0 0.1.0] [copyright "2024"] -[titledesc {Module API}] [comment {-- Name section and table of contents description --}] -[moddesc {-}] [comment {-- Description at end of page heading --}] +[titledesc {punkshell package/module loading}] [comment {-- Name section and table of contents description --}] +[moddesc {package/module load}] [comment {-- Description at end of page heading --}] [require punk::packagepreference] -[keywords module] +[keywords module package] [description] [para] - [section Overview] diff --git a/src/doc/punk/_module_rest-0.1.0.tm.man b/src/doc/punk/_module_rest-0.1.0.tm.man new file mode 100644 index 00000000..4f6bd0d0 --- /dev/null +++ b/src/doc/punk/_module_rest-0.1.0.tm.man @@ -0,0 +1,42 @@ +[comment {--- punk::docgen generated from inline doctools comments ---}] +[comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] +[comment {--- punk::docgen overwrites this file ---}] +[manpage_begin punkshell_module_punk::rest 0 0.1.0] +[copyright "2024"] +[titledesc {punk::rest}] [comment {-- Name section and table of contents description --}] +[moddesc {experimental rest}] [comment {-- Description at end of page heading --}] +[require punk::rest] +[keywords module rest http] +[description] +[para] Experimental *basic rest as wrapper over http lib - use tcllib's rest package for a more complete implementation of a rest client +[section Overview] +[para] overview of punk::rest +[subsection Concepts] +[para] - +[subsection dependencies] +[para] packages used by punk::rest +[list_begin itemized] +[item] [package {Tcl 8.6}] +[list_end] +[section API] +[subsection {Namespace punk::rest::class}] +[para] class definitions +if {[tcl::info::commands [tcl::namespace::current]::interface_sample1] eq ""} { +[list_begin enumerated] +[list_end] [comment {--- end class enumeration ---}] +} +} + ++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +[subsection {Namespace punk::rest}] +[para] Core API functions for punk::rest +[list_begin definitions] +[list_end] [comment {--- end definitions namespace punk::rest ---}] +[subsection {Namespace punk::rest::lib}] +[para] Secondary functions that are part of the API +[list_begin definitions] +[list_end] [comment {--- end definitions namespace punk::rest::lib ---}] +[section Internal] +tcl::namespace::eval punk::rest::system { +[subsection {Namespace punk::rest::system}] +[para] Internal functions that are not part of the API +[manpage_end] diff --git a/src/doc/punk/_module_sshrun-0.1.0.tm.man b/src/doc/punk/_module_sshrun-0.1.0.tm.man index 211ce637..9484f0e4 100644 --- a/src/doc/punk/_module_sshrun-0.1.0.tm.man +++ b/src/doc/punk/_module_sshrun-0.1.0.tm.man @@ -1,7 +1,7 @@ [comment {--- punk::docgen generated from inline doctools comments ---}] [comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] [comment {--- punk::docgen overwrites this file ---}] -[manpage_begin shellspy_module_punk::sshrun 0 0.1.0] +[manpage_begin punkshell_module_punk::sshrun 0 0.1.0] [copyright "2009"] [titledesc {Tcl procedures to execute tcl scripts in remote hosts}] [comment {-- Name section and table of contents description --}] [moddesc {punk::sshrun tclssh clone}] [comment {-- Description at end of page heading --}] diff --git a/src/doc/punk/_module_trie-0.1.0.tm.man b/src/doc/punk/_module_trie-0.1.0.tm.man new file mode 100644 index 00000000..35bd59b0 --- /dev/null +++ b/src/doc/punk/_module_trie-0.1.0.tm.man @@ -0,0 +1,39 @@ +[comment {--- punk::docgen generated from inline doctools comments ---}] +[comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] +[comment {--- punk::docgen overwrites this file ---}] +[manpage_begin punkshell_module_punk::trie 0 0.1.0] +[copyright "2010"] +[titledesc {punk::trie API}] [comment {-- Name section and table of contents description --}] +[moddesc {punk::trie}] [comment {-- Description at end of page heading --}] +[require punk::trie] +[keywords module datastructure trie] +[description] tcl trie implementation courtesy of CmcC (tcl wiki) +[para] - +[section Overview] +[para] overview of punk::trie +[subsection Concepts] +[para] - +[subsection dependencies] +[para] packages used by punk::trie +[list_begin itemized] +[item] [package {Tcl 8.6}] +[list_end] +[section API] +[subsection {Namespace punk::trie}] +[para] Core API functions for punk::trie +[list_begin enumerated] +[enum] CLASS [class trieclass] +[list_begin definitions] +[call class::trieclass [method matches] [arg t] [arg what]] +[para] search for longest prefix, return matching prefix, element and suffix +[list_end] [comment {--- end definitions ---}] +[list_end] [comment {--- end class enumeration ---}] +[subsection {Namespace punk::trie::lib}] +[para] Secondary functions that are part of the API +[list_begin definitions] +[list_end] [comment {--- end definitions namespace punk::trie::lib ---}] +[section Internal] +tcl::namespace::eval punk::trie::system { +[subsection {Namespace punk::trie::system}] +[para] Internal functions that are not part of the API +[manpage_end] diff --git a/src/doc/punk/_module_uc-0.1.0.tm.man b/src/doc/punk/_module_uc-0.1.0.tm.man index 9db4d9ca..dec79dd0 100644 --- a/src/doc/punk/_module_uc-0.1.0.tm.man +++ b/src/doc/punk/_module_uc-0.1.0.tm.man @@ -1,12 +1,12 @@ [comment {--- punk::docgen generated from inline doctools comments ---}] [comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] [comment {--- punk::docgen overwrites this file ---}] -[manpage_begin shellspy_module_punk::uc 0 0.1.0] +[manpage_begin punkshell_module_punk::uc 0 0.1.0] [copyright "2024"] [titledesc {Module API}] [comment {-- Name section and table of contents description --}] [moddesc {-}] [comment {-- Description at end of page heading --}] [require punk::uc] -[keywords module] +[keywords module unofficial unicode wcswidth] [description] [para] - [section Overview] diff --git a/src/doc/punk/_module_winlnk-0.1.0.tm.man b/src/doc/punk/_module_winlnk-0.1.0.tm.man new file mode 100644 index 00000000..68903e51 --- /dev/null +++ b/src/doc/punk/_module_winlnk-0.1.0.tm.man @@ -0,0 +1,50 @@ +[comment {--- punk::docgen generated from inline doctools comments ---}] +[comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] +[comment {--- punk::docgen overwrites this file ---}] +[manpage_begin punkshell_module_punk::winlnk 0 0.1.0] +[copyright "2024"] +[titledesc {windows shortcut .lnk library}] [comment {-- Name section and table of contents description --}] +[moddesc {punk::winlnk}] [comment {-- Description at end of page heading --}] +[require punk::winlnk] +[keywords module shortcut lnk parse windows crossplatform] +[description] +[para] Tools for reading windows shortcuts (.lnk files) on any platform +[section Overview] +[para] overview of punk::winlnk +[subsection Concepts] +[para] Windows shortcuts are a binary format file with a .lnk extension +[para] Shell Link (.LNK) Binary File Format is documented in [lb]MS_SHLLINK[rb].pdf published by Microsoft. +[para] Revision 8.0 published 2024-04-23 +[subsection dependencies] +[para] packages used by punk::winlnk +[list_begin itemized] +[item] [package {Tcl 8.6}] +[list_end] +[section API] +[subsection {Namespace punk::winlnk::class}] +[para] class definitions +if {[tcl::info::commands [tcl::namespace::current]::interface_sample1] eq ""} { +[list_begin enumerated] +[list_end] [comment {--- end class enumeration ---}] +} +} + ++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +[subsection {Namespace punk::winlnk}] +[para] Core API functions for punk::winlnk +[list_begin definitions] +[call [fun file_check_header] [arg path] ] +[para]Return 0|1 +[para]Determines if the .lnk file specified in path has a valid header for a windows shortcut +[call [fun file_get_info] [arg path] ] +[para] Return a dict of info obtained by parsing the binary data in a windows .lnk file +[para] If the .lnk header check fails, then the .lnk file probably isn't really a shortcut file and the dictionary will contain an 'error' key +[list_end] [comment {--- end definitions namespace punk::winlnk ---}] +[subsection {Namespace punk::winlnk::lib}] +[para] Secondary functions that are part of the API +[list_begin definitions] +[list_end] [comment {--- end definitions namespace punk::winlnk::lib ---}] +[section Internal] +tcl::namespace::eval punk::winlnk::system { +[subsection {Namespace punk::winlnk::system}] +[para] Internal functions that are not part of the API +[manpage_end] diff --git a/src/doc/punk/_module_zip-0.1.1.tm.man b/src/doc/punk/_module_zip-0.1.1.tm.man new file mode 100644 index 00000000..fc17f47b --- /dev/null +++ b/src/doc/punk/_module_zip-0.1.1.tm.man @@ -0,0 +1,66 @@ +[comment {--- punk::docgen generated from inline doctools comments ---}] +[comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] +[comment {--- punk::docgen overwrites this file ---}] +[manpage_begin punkshell_module_punk::zip 0 0.1.1] +[copyright "2024"] +[titledesc {Module API}] [comment {-- Name section and table of contents description --}] +[moddesc {-}] [comment {-- Description at end of page heading --}] +[require punk::zip] +[keywords module zip fileformat] +[description] +[para] - +[section Overview] +[para] overview of punk::zip +[subsection Concepts] +[para] - +[subsection dependencies] +[para] packages used by punk::zip +[list_begin itemized] +[item] [package {Tcl 8.6}] +[item] [package {punk::args}] +[list_end] +[section API] +[subsection {Namespace punk::zip}] +[para] Core API functions for punk::zip +[list_begin definitions] +[call [fun Timet_to_dos] [arg time_t]] +[para] convert a unix timestamp into a DOS timestamp for ZIP times. +[example { + DOS timestamps are 32 bits split into bit regions as follows: + 24 16 8 0 + +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ + |Y|Y|Y|Y|Y|Y|Y|m| |m|m|m|d|d|d|d|d| |h|h|h|h|h|m|m|m| |m|m|m|s|s|s|s|s| + +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +}] +[call [fun walk] [arg ?options?] [arg base]] +[para] Walk a directory tree rooted at base +[para] the -excludes list can be a set of glob expressions to match against files and avoid +[para] e.g +[example { + punk::zip::walk -exclude {CVS/* *~.#*} library +}] +[call [fun Addentry] [arg zipchan] [arg base] [arg path] [arg ?comment?]] +[para] Add a single file to a zip archive +[para] The zipchan channel should already be open and binary. +[para] You can provide a -comment for the file. +[para] The return value is the central directory record that will need to be used when finalizing the zip archive. +[call [fun mkzip]\ + [opt "[option -offsettype] [arg offsettype]"]\ + [opt "[option -return] [arg returntype]"]\ + [opt "[option -zipkit] [arg 0|1]"]\ + [opt "[option -runtime] [arg preamble_filename]"]\ + [opt "[option -comment] [arg zipfilecomment]"]\ + [opt "[option -directory] [arg dir_to_zip]"]\ + [opt "[option -base] [arg archive_root]"]\ + [opt "[option -exclude] [arg globlist]"]\ + [arg zipfilename]\ + [arg ?glob...?]] +[para] Create a zip archive in 'zipfilename' +[para] If a file already exists, an error will be raised. +[para] Call 'punk::zip::mkzip' with no arguments for usage display. +[list_end] [comment {--- end definitions namespace punk::zip ---}] +[subsection {Namespace punk::zip::lib}] +[para] Secondary functions that are part of the API +[list_begin definitions] +[list_end] [comment {--- end definitions namespace punk::zip::lib ---}] +[manpage_end] diff --git a/src/doc/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.man b/src/doc/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.man index 16c153f7..d8353aa4 100644 --- a/src/doc/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.man +++ b/src/doc/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.man @@ -1,9 +1,45 @@ [comment {--- punk::docgen generated from inline doctools comments ---}] [comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}] [comment {--- punk::docgen overwrites this file ---}] +[manpage_begin punkshell_module_scriptwrap 0 0.1.0] +[copyright "2024"] +[titledesc {scriptwrap polyglot tool}] [comment {-- Name section and table of contents description --}] +[moddesc {scriptwrap tool}] [comment {-- Description at end of page heading --}] +[require punk::mix::commandset::scriptwrap] +[keywords module commandset launcher scriptwrap] +[description] +[para] - +[section Overview] +[para] overview of scriptwrap +[subsection Concepts] +[para] - +[subsection dependencies] +[para] packages used by poshinfo +[list_begin itemized] +[item] [package {Tcl 8.6}] +[item] [package {punk::lib}] +[item] [package {punk::args}] +[item] [package {punk::mix}] +[item] [package {punk::base}] +[item] [package {punk::fileline}] +[list_end] +[section API] +[subsection {Namespace punk::mix::commandset::scriptwrap}] +[para] Core API functions for punk::mix::commandset::scriptwrap +[list_begin definitions] +[list_end] [comment {--- end definitions namespace punk::mix::commandset::scriptwrap ---}] +[subsection {Namespace punk::mix::commandset::scriptwrap::lib}] +[para] Library API functions for punk::mix::commandset::scriptwrap +[list_begin definitions] [call [fun get_wrapper_folders] [arg args] ] -[para] Return list of dicts representing wrapper folders. keys: basefolder sourceinfo +[para] Return list of dicts representing wrapper folders in the project. keys: basefolder sourceinfo [para] Arguments: [list_begin arguments] [arg_def string args] name-value pairs -scriptpath [list_end] +[list_end] [comment {--- end definitions namespace punk::mix::commandset::scriptwrap::lib ---}] +[subsection {Namespace punk::mix::commandset::scriptwrap::batchlib}] +[para] Utility funcions for processing windows .bat files +[list_begin definitions] +[list_end] [comment {--- end definitions namespace punk::mix::commandset::scriptwrap::batchlib ---}] +[manpage_end] diff --git a/src/doc/punk/nav/_module_fs-0.1.0.tm.man b/src/doc/punk/nav/_module_fs-0.1.0.tm.man index 9575758b..94a6f7e8 100644 --- a/src/doc/punk/nav/_module_fs-0.1.0.tm.man +++ b/src/doc/punk/nav/_module_fs-0.1.0.tm.man @@ -3,10 +3,10 @@ [comment {--- punk::docgen overwrites this file ---}] [manpage_begin shellspy_module_punk::nav::fs 0 0.1.0] [copyright "2024"] -[titledesc {Module API}] [comment {-- Name section and table of contents description --}] -[moddesc {-}] [comment {-- Description at end of page heading --}] +[titledesc {punk::nav::fs console filesystem navigation}] [comment {-- Name section and table of contents description --}] +[moddesc {fs nav}] [comment {-- Description at end of page heading --}] [require punk::nav::fs] -[keywords module] +[keywords module filesystem terminal] [description] [para] - [section Overview] diff --git a/src/doc/punk/repl/_module_codethread-0.1.0.tm.man b/src/doc/punk/repl/_module_codethread-0.1.0.tm.man index 5832da93..cf3eddbc 100644 --- a/src/doc/punk/repl/_module_codethread-0.1.0.tm.man +++ b/src/doc/punk/repl/_module_codethread-0.1.0.tm.man @@ -3,12 +3,12 @@ [comment {--- punk::docgen overwrites this file ---}] [manpage_begin shellspy_module_punk::repl::codethread 0 0.1.0] [copyright "2024"] -[titledesc {Module API}] [comment {-- Name section and table of contents description --}] -[moddesc {-}] [comment {-- Description at end of page heading --}] +[titledesc {Module repl codethread}] [comment {-- Name section and table of contents description --}] +[moddesc {codethread for repl - root interpreter}] [comment {-- Description at end of page heading --}] [require punk::repl::codethread] -[keywords module] +[keywords module repl] [description] -[para] - +[para] This is part of the infrastructure required for the punk::repl to operate [section Overview] [para] overview of punk::repl::codethread [subsection Concepts] diff --git a/src/embedded/man/files/_module_argparsingtest-0.1.0.tm.n b/src/embedded/man/files/_module_argparsingtest-0.1.0.tm.n index be814a6b..636b7f8b 100644 --- a/src/embedded/man/files/_module_argparsingtest-0.1.0.tm.n +++ b/src/embedded/man/files/_module_argparsingtest-0.1.0.tm.n @@ -2,7 +2,7 @@ '\" Generated from file '_module_argparsingtest-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2024 '\" -.TH "shellspy_module_argparsingtest" 0 0\&.1\&.0 doc "-" +.TH "punkshell_module_argparsingtest" 0 0\&.1\&.0 doc "-" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" @@ -272,7 +272,7 @@ Database Class: \\fB\\$3\\fR .. .BS .SH NAME -shellspy_module_argparsingtest \- Module API +punkshell_module_argparsingtest \- Module API .SH SYNOPSIS package require \fBargparsingtest \fR .sp diff --git a/src/embedded/man/files/_module_fauxlink-0.1.1.tm.n b/src/embedded/man/files/_module_fauxlink-0.1.1.tm.n new file mode 100644 index 00000000..de71d6be --- /dev/null +++ b/src/embedded/man/files/_module_fauxlink-0.1.1.tm.n @@ -0,0 +1,383 @@ +'\" +'\" Generated from file '_module_fauxlink-0\&.1\&.1\&.tm\&.man' by tcllib/doctools with format 'nroff' +'\" Copyright (c) 2024 +'\" +.TH "fauxlink_module_fauxlink" 0 0\&.1\&.1 doc "fauxlink \&.fxlnk" +.\" The -*- nroff -*- definitions below are for supplemental macros used +.\" in Tcl/Tk manual entries. +.\" +.\" .AP type name in/out ?indent? +.\" Start paragraph describing an argument to a library procedure. +.\" type is type of argument (int, etc.), in/out is either "in", "out", +.\" or "in/out" to describe whether procedure reads or modifies arg, +.\" and indent is equivalent to second arg of .IP (shouldn't ever be +.\" needed; use .AS below instead) +.\" +.\" .AS ?type? ?name? +.\" Give maximum sizes of arguments for setting tab stops. Type and +.\" name are examples of largest possible arguments that will be passed +.\" to .AP later. If args are omitted, default tab stops are used. +.\" +.\" .BS +.\" Start box enclosure. From here until next .BE, everything will be +.\" enclosed in one large box. +.\" +.\" .BE +.\" End of box enclosure. +.\" +.\" .CS +.\" Begin code excerpt. +.\" +.\" .CE +.\" End code excerpt. +.\" +.\" .VS ?version? ?br? +.\" Begin vertical sidebar, for use in marking newly-changed parts +.\" of man pages. The first argument is ignored and used for recording +.\" the version when the .VS was added, so that the sidebars can be +.\" found and removed when they reach a certain age. If another argument +.\" is present, then a line break is forced before starting the sidebar. +.\" +.\" .VE +.\" End of vertical sidebar. +.\" +.\" .DS +.\" Begin an indented unfilled display. +.\" +.\" .DE +.\" End of indented unfilled display. +.\" +.\" .SO ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three columns separated by tabs. +.\" +.\" .SE +.\" End of list of standard options for a Tk widget. +.\" +.\" .OP cmdName dbName dbClass +.\" Start of description of a specific option. cmdName gives the +.\" option's name as specified in the class command, dbName gives +.\" the option's name in the option database, and dbClass gives +.\" the option's class in the option database. +.\" +.\" .UL arg1 arg2 +.\" Print arg1 underlined, then print arg2 normally. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. +.if t .wh -1.3i ^B +.nr ^l \n(.l +.ad b +.\" # Start an argument description +.de AP +.ie !"\\$4"" .TP \\$4 +.el \{\ +. ie !"\\$2"" .TP \\n()Cu +. el .TP 15 +.\} +.ta \\n()Au \\n()Bu +.ie !"\\$3"" \{\ +\&\\$1 \\fI\\$2\\fP (\\$3) +.\".b +.\} +.el \{\ +.br +.ie !"\\$2"" \{\ +\&\\$1 \\fI\\$2\\fP +.\} +.el \{\ +\&\\fI\\$1\\fP +.\} +.\} +.. +.\" # define tabbing values for .AP +.de AS +.nr )A 10n +.if !"\\$1"" .nr )A \\w'\\$1'u+3n +.nr )B \\n()Au+15n +.\" +.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n +.nr )C \\n()Bu+\\w'(in/out)'u+2n +.. +.AS Tcl_Interp Tcl_CreateInterp in/out +.\" # BS - start boxed text +.\" # ^y = starting y location +.\" # ^b = 1 +.de BS +.br +.mk ^y +.nr ^b 1u +.if n .nf +.if n .ti 0 +.if n \l'\\n(.lu\(ul' +.if n .fi +.. +.\" # BE - end boxed text (draw box now) +.de BE +.nf +.ti 0 +.mk ^t +.ie n \l'\\n(^lu\(ul' +.el \{\ +.\" Draw four-sided box normally, but don't draw top of +.\" box if the box started on an earlier page. +.ie !\\n(^b-1 \{\ +\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' +.\} +.el \}\ +\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' +.\} +.\} +.fi +.br +.nr ^b 0 +.. +.\" # VS - start vertical sidebar +.\" # ^Y = starting y location +.\" # ^v = 1 (for troff; for nroff this doesn't matter) +.de VS +.if !"\\$2"" .br +.mk ^Y +.ie n 'mc \s12\(br\s0 +.el .nr ^v 1u +.. +.\" # VE - end of vertical sidebar +.de VE +.ie n 'mc +.el \{\ +.ev 2 +.nf +.ti 0 +.mk ^t +\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' +.sp -1 +.fi +.ev +.\} +.nr ^v 0 +.. +.\" # Special macro to handle page bottom: finish off current +.\" # box/sidebar if in box/sidebar mode, then invoked standard +.\" # page bottom macro. +.de ^B +.ev 2 +'ti 0 +'nf +.mk ^t +.if \\n(^b \{\ +.\" Draw three-sided box if this is the box's first page, +.\" draw two sides but no top otherwise. +.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c +.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c +.\} +.if \\n(^v \{\ +.nr ^x \\n(^tu+1v-\\n(^Yu +\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c +.\} +.bp +'fi +.ev +.if \\n(^b \{\ +.mk ^y +.nr ^b 2 +.\} +.if \\n(^v \{\ +.mk ^Y +.\} +.. +.\" # DS - begin display +.de DS +.RS +.nf +.sp +.. +.\" # DE - end display +.de DE +.fi +.RE +.sp +.. +.\" # SO - start of list of standard options +.de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR +.SH "STANDARD OPTIONS" +.LP +.nf +.ta 5.5c 11c +.ft B +.. +.\" # SE - end of list of standard options +.de SE +.fi +.ft R +.LP +See the \\*(So manual entry for details on the standard options. +.. +.\" # OP - start of full description for a single option +.de OP +.LP +.nf +.ta 4c +Command-Line Name: \\fB\\$1\\fR +Database Name: \\fB\\$2\\fR +Database Class: \\fB\\$3\\fR +.fi +.IP +.. +.\" # CS - begin code excerpt +.de CS +.RS +.nf +.ta .25i .5i .75i 1i +.. +.\" # CE - end code excerpt +.de CE +.fi +.RE +.. +.\" # UL - underline word +.de UL +\\$1\l'|0\(ul'\\$2 +.. +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. +.BS +.SH NAME +fauxlink_module_fauxlink \- faux link application shortcuts +.SH SYNOPSIS +package require \fBfauxlink \fR +.sp +.BE +.SH DESCRIPTION +.PP +A cross platform shortcut/symlink alternative\&. +.PP +Unapologetically ugly - but practical in certain circumstances\&. +.PP +A solution is required for application-driven filesystem links that survives cross platform moves as well as +.PP +archiving and packaging systems\&. +.PP +The target is specified in a minimally-encoded form in the filename itself - but still human readable\&. +.PP +format of name #\&.fxlnk +.PP +where can be empty - then the effective nominal name is the tail of the +.PP +The + symbol substitutes for forward-slashes\&. +.PP +Other chars can be encoded using url-like encoding - (but only up to %7E !) +.PP +We deliberately treat higher % sequences literally\&. +.PP +This means actual uri::urn encoded unicode sequences (e\&.g %E2%99%A5 [heart]) can remain literal for linking to urls\&. +.PP +e\&.g if an actual + or # is required in a filename or path segment they can be encoded as %2B & %23 +.PP +e\&.g a link to a file file#A\&.txt in parent dir could be: +.PP +file%23A\&.txt#\&.\&.+file%23A\&.txt\&.fxlnk +.PP +or equivalently (but obviously affecting sorting) #\&.\&.+file%23A\&.txt\&.fxlnk +.PP +The can be unrelated to the actual target +.PP +e\&.g datafile\&.dat#\&.\&.+file%23A\&.txt\&.fxlnk +.PP +This system has no filesystem support - and must be completely application driven\&. +.PP +This can be useful for example in application test packages which may be tarred or zipped and moved cross platform\&. +.PP +The target being fully specified in the name means the file doesn't have to be read for the target to be determined +.PP +Extensions to behaviour should be added in the file as text data in Toml format, +.PP +with custom data being under a single application-chosen table name +.PP +The toplevel Toml table [fauxlink] is reserved for core extensions to this system\&. +.PP +Aside from the 2 used for delimiting (+ #) +.PP +certain characters which might normally be allowed in filesystems are required to be encoded +.PP +e\&.g space and tab are required to be %20 %09 +.PP +Others that require encoding are: * ? \\ / | : ; " < > +.PP +The nul character in raw form, when detected, is always mapped away to the empty string - as very few filesystems support it\&. +.PP +Control characters and other punctuation is optional to encode\&. +.PP +Generally utf-8 should be used where possible and unicode characters can often be left unencoded on modern systems\&. +.PP +Where encoding of unicode is desired in the nominalname,encodedtarget,tag or comment portions it can be specified as %UXXXXXXXX +.PP +There must be between 1 and 8 X digits following the %U\&. Interpretation of chars following %U stops at the first non-hex character\&. +.PP +This means %Utest would not get any translation as there were no hex digits so it would come out as %Utest +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +.SH OVERVIEW +.PP +overview of fauxlink +.SS CONCEPTS +.PP +- +.SS DEPENDENCIES +.PP +packages used by fauxlink +.IP \(bu +\fBTcl 8\&.6-\fR +.PP +.SH API +.SS "NAMESPACE FAUXLINK::CLASS" +.PP +class definitions +.PP +.SS "NAMESPACE FAUXLINK" +.PP +Core API functions for fauxlink +.PP +.SS "NAMESPACE FAUXLINK::LIB" +.PP +Secondary functions that are part of the API +.PP +.SH INTERNAL +.SS "NAMESPACE FAUXLINK::SYSTEM" +.PP +Internal functions that are not part of the API +.SH KEYWORDS +fake, faux, shortcut, symlink, toml +.SH COPYRIGHT +.nf +Copyright (c) 2024 + +.fi diff --git a/src/embedded/man/files/_module_modpod-0.1.0.tm.n b/src/embedded/man/files/_module_modpod-0.1.2.tm.n similarity index 93% rename from src/embedded/man/files/_module_modpod-0.1.0.tm.n rename to src/embedded/man/files/_module_modpod-0.1.2.tm.n index 8833b215..5a902a2f 100644 --- a/src/embedded/man/files/_module_modpod-0.1.0.tm.n +++ b/src/embedded/man/files/_module_modpod-0.1.2.tm.n @@ -1,8 +1,8 @@ '\" -'\" Generated from file '_module_modpod-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' +'\" Generated from file '_module_modpod-0\&.1\&.2\&.tm\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2024 '\" -.TH "modpod_module_modpod" 0 0\&.1\&.0 doc "-" +.TH "modpod_module_modpod" 0 0\&.1\&.2 doc "-" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" diff --git a/src/embedded/man/files/_module_overtype-1.6.5.tm.n b/src/embedded/man/files/_module_overtype-1.6.5.tm.n index e1ed146c..cf99ebe0 100644 --- a/src/embedded/man/files/_module_overtype-1.6.5.tm.n +++ b/src/embedded/man/files/_module_overtype-1.6.5.tm.n @@ -313,7 +313,7 @@ Core API functions for overtype .TP \fBovertype::renderspace\fR \fIargs\fR .sp -usage: ?-transparent [0|1]? ?-overflow [1|0]? ?-ellipsis [1|0]? ?-ellipsistext \&.\&.\&.? undertext overtext +usage: ?-transparent [0|1]? ?-expand_right [1|0]? ?-ellipsis [1|0]? ?-ellipsistext \&.\&.\&.? undertext overtext .TP \fBovertype::renderline\fR \fIargs\fR .sp diff --git a/src/embedded/man/files/_module_poshinfo-0.1.0.tm.n b/src/embedded/man/files/_module_poshinfo-0.1.0.tm.n index 09ba5d9c..28ddbada 100644 --- a/src/embedded/man/files/_module_poshinfo-0.1.0.tm.n +++ b/src/embedded/man/files/_module_poshinfo-0.1.0.tm.n @@ -2,7 +2,7 @@ '\" Generated from file '_module_poshinfo-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2024 '\" -.TH "shellspy_module_poshinfo" 0 0\&.1\&.0 doc "-" +.TH "punkshell_module_poshinfo" 0 0\&.1\&.0 doc "POSH-related prompt tool" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" @@ -272,7 +272,7 @@ Database Class: \\fB\\$3\\fR .. .BS .SH NAME -shellspy_module_poshinfo \- Module API +punkshell_module_poshinfo \- poshinfo prompt theme tool .SH SYNOPSIS package require \fBposhinfo \fR .sp @@ -300,11 +300,7 @@ packages used by poshinfo .SS "NAMESPACE POSHINFO::CLASS" .PP class definitions -if { eq ""} { .PP -} -} -++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ .SS "NAMESPACE POSHINFO" .PP Core API functions for poshinfo @@ -314,12 +310,11 @@ Core API functions for poshinfo Secondary functions that are part of the API .PP .SH INTERNAL -tcl::namespace::eval poshinfo::system { .SS "NAMESPACE POSHINFO::SYSTEM" .PP Internal functions that are not part of the API .SH KEYWORDS -module +POSH, console, module, prompt, prompt theme, terminal, theme .SH COPYRIGHT .nf Copyright (c) 2024 diff --git a/src/embedded/man/files/_module_textblock-0.1.1.tm.n b/src/embedded/man/files/_module_textblock-0.1.1.tm.n index a496bb29..40bcfdac 100644 --- a/src/embedded/man/files/_module_textblock-0.1.1.tm.n +++ b/src/embedded/man/files/_module_textblock-0.1.1.tm.n @@ -320,7 +320,7 @@ class definitions \fIhandler_classes\fR .RS .IP [1] -CLASS \fBinterface_caphandler\&.registry\fR +CLASS \fBtextblock::class::table\fR .RS .sp \fIMETHODS\fR diff --git a/src/embedded/man/files/_module_textblock-0.1.2.tm.n b/src/embedded/man/files/_module_textblock-0.1.2.tm.n new file mode 100644 index 00000000..f355644c --- /dev/null +++ b/src/embedded/man/files/_module_textblock-0.1.2.tm.n @@ -0,0 +1,512 @@ +'\" +'\" Generated from file '_module_textblock-0\&.1\&.2\&.tm\&.man' by tcllib/doctools with format 'nroff' +'\" Copyright (c) 2024 +'\" +.TH "punkshell_module_textblock" 0 0\&.1\&.2 doc "punk textblock" +.\" The -*- nroff -*- definitions below are for supplemental macros used +.\" in Tcl/Tk manual entries. +.\" +.\" .AP type name in/out ?indent? +.\" Start paragraph describing an argument to a library procedure. +.\" type is type of argument (int, etc.), in/out is either "in", "out", +.\" or "in/out" to describe whether procedure reads or modifies arg, +.\" and indent is equivalent to second arg of .IP (shouldn't ever be +.\" needed; use .AS below instead) +.\" +.\" .AS ?type? ?name? +.\" Give maximum sizes of arguments for setting tab stops. Type and +.\" name are examples of largest possible arguments that will be passed +.\" to .AP later. If args are omitted, default tab stops are used. +.\" +.\" .BS +.\" Start box enclosure. From here until next .BE, everything will be +.\" enclosed in one large box. +.\" +.\" .BE +.\" End of box enclosure. +.\" +.\" .CS +.\" Begin code excerpt. +.\" +.\" .CE +.\" End code excerpt. +.\" +.\" .VS ?version? ?br? +.\" Begin vertical sidebar, for use in marking newly-changed parts +.\" of man pages. The first argument is ignored and used for recording +.\" the version when the .VS was added, so that the sidebars can be +.\" found and removed when they reach a certain age. If another argument +.\" is present, then a line break is forced before starting the sidebar. +.\" +.\" .VE +.\" End of vertical sidebar. +.\" +.\" .DS +.\" Begin an indented unfilled display. +.\" +.\" .DE +.\" End of indented unfilled display. +.\" +.\" .SO ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three columns separated by tabs. +.\" +.\" .SE +.\" End of list of standard options for a Tk widget. +.\" +.\" .OP cmdName dbName dbClass +.\" Start of description of a specific option. cmdName gives the +.\" option's name as specified in the class command, dbName gives +.\" the option's name in the option database, and dbClass gives +.\" the option's class in the option database. +.\" +.\" .UL arg1 arg2 +.\" Print arg1 underlined, then print arg2 normally. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. +.if t .wh -1.3i ^B +.nr ^l \n(.l +.ad b +.\" # Start an argument description +.de AP +.ie !"\\$4"" .TP \\$4 +.el \{\ +. ie !"\\$2"" .TP \\n()Cu +. el .TP 15 +.\} +.ta \\n()Au \\n()Bu +.ie !"\\$3"" \{\ +\&\\$1 \\fI\\$2\\fP (\\$3) +.\".b +.\} +.el \{\ +.br +.ie !"\\$2"" \{\ +\&\\$1 \\fI\\$2\\fP +.\} +.el \{\ +\&\\fI\\$1\\fP +.\} +.\} +.. +.\" # define tabbing values for .AP +.de AS +.nr )A 10n +.if !"\\$1"" .nr )A \\w'\\$1'u+3n +.nr )B \\n()Au+15n +.\" +.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n +.nr )C \\n()Bu+\\w'(in/out)'u+2n +.. +.AS Tcl_Interp Tcl_CreateInterp in/out +.\" # BS - start boxed text +.\" # ^y = starting y location +.\" # ^b = 1 +.de BS +.br +.mk ^y +.nr ^b 1u +.if n .nf +.if n .ti 0 +.if n \l'\\n(.lu\(ul' +.if n .fi +.. +.\" # BE - end boxed text (draw box now) +.de BE +.nf +.ti 0 +.mk ^t +.ie n \l'\\n(^lu\(ul' +.el \{\ +.\" Draw four-sided box normally, but don't draw top of +.\" box if the box started on an earlier page. +.ie !\\n(^b-1 \{\ +\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' +.\} +.el \}\ +\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' +.\} +.\} +.fi +.br +.nr ^b 0 +.. +.\" # VS - start vertical sidebar +.\" # ^Y = starting y location +.\" # ^v = 1 (for troff; for nroff this doesn't matter) +.de VS +.if !"\\$2"" .br +.mk ^Y +.ie n 'mc \s12\(br\s0 +.el .nr ^v 1u +.. +.\" # VE - end of vertical sidebar +.de VE +.ie n 'mc +.el \{\ +.ev 2 +.nf +.ti 0 +.mk ^t +\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' +.sp -1 +.fi +.ev +.\} +.nr ^v 0 +.. +.\" # Special macro to handle page bottom: finish off current +.\" # box/sidebar if in box/sidebar mode, then invoked standard +.\" # page bottom macro. +.de ^B +.ev 2 +'ti 0 +'nf +.mk ^t +.if \\n(^b \{\ +.\" Draw three-sided box if this is the box's first page, +.\" draw two sides but no top otherwise. +.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c +.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c +.\} +.if \\n(^v \{\ +.nr ^x \\n(^tu+1v-\\n(^Yu +\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c +.\} +.bp +'fi +.ev +.if \\n(^b \{\ +.mk ^y +.nr ^b 2 +.\} +.if \\n(^v \{\ +.mk ^Y +.\} +.. +.\" # DS - begin display +.de DS +.RS +.nf +.sp +.. +.\" # DE - end display +.de DE +.fi +.RE +.sp +.. +.\" # SO - start of list of standard options +.de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR +.SH "STANDARD OPTIONS" +.LP +.nf +.ta 5.5c 11c +.ft B +.. +.\" # SE - end of list of standard options +.de SE +.fi +.ft R +.LP +See the \\*(So manual entry for details on the standard options. +.. +.\" # OP - start of full description for a single option +.de OP +.LP +.nf +.ta 4c +Command-Line Name: \\fB\\$1\\fR +Database Name: \\fB\\$2\\fR +Database Class: \\fB\\$3\\fR +.fi +.IP +.. +.\" # CS - begin code excerpt +.de CS +.RS +.nf +.ta .25i .5i .75i 1i +.. +.\" # CE - end code excerpt +.de CE +.fi +.RE +.. +.\" # UL - underline word +.de UL +\\$1\l'|0\(ul'\\$2 +.. +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. +.BS +.SH NAME +punkshell_module_textblock \- punk textblock functions +.SH SYNOPSIS +package require \fBtextblock \fR +.sp +class::table \fBconstructor\fR \fIargs\fR +.sp +class::table \fBconfigure\fR \fIargs\fR +.sp +class::table \fBprintmatrix\fR \fImatrix\fR +.sp +class::table \fBas_matrix\fR \fI?cmd?\fR +.sp +class::table \fBadd_column\fR \fIargs\fR +.sp +class::table \fBcolumn_count\fR +.sp +class::table \fBconfigure_column\fR \fIindex_expression\fR \fIargs\fR +.sp +class::table \fBheader_count\fR +.sp +class::table \fBheader_height\fR \fIheader_index\fR +.sp +class::table \fBheader_colspans\fR +.sp +class::table \fBconfigure_header\fR +.sp +class::table \fBadd_row\fR \fIvaluelist\fR ?\fB-minheight\fR \fIint_minheight\fR? ?\fB-maxheight\fR \fIint_maxheight\fR? ?\fB-ansibase\fR \fIansicode\fR? +.sp +class::table \fBconfigure_row\fR \fIindex_expression\fR ?\fB-minheight\fR \fIint_minheight\fR? ?\fB-maxheight\fR \fIint_maxheight\fR? ?\fB-ansibase\fR \fIansicode\fR? +.sp +class::table \fBrow_count\fR +.sp +class::table \fBrow_clear\fR +.sp +class::table \fBclear\fR +.sp +class::table \fBget_column_cells_by_index\fR \fIindex_expression\fR +.sp +class::table \fBget_column_values_by_index\fR \fIindex_expression\fR +.sp +class::table \fBdebug\fR +.sp +class::table \fBcolumn_width\fR \fIindex_expression\fR +.sp +class::table \fBcolumn_width\fR +.sp +class::table \fBwidth\fR +.sp +class::table \fBspangroups\fR +.sp +class::table \fBprint\fR +.sp +class::table \fBprint_bodymatrix\fR +.sp +.BE +.SH DESCRIPTION +.PP +Ansi-aware terminal textblock manipulation +.SH OVERVIEW +.PP +overview of textblock +.SS CONCEPTS +.PP +.SS DEPENDENCIES +.PP +packages used by textblock +.IP \(bu +\fBTcl 8\&.6-\fR +.IP \(bu +\fBpunk::args\fR +.IP \(bu +\fBpunk::char\fR +.IP \(bu +\fBpunk::ansi\fR +.IP \(bu +\fBpunk::lib\fR +.IP \(bu +\fBovertype\fR +.IP \(bu +\fBterm::ansi::code::macros\fR +.IP \(bu +\fBtextutil\fR +.PP +.SH API +.SS "NAMESPACE TEXTBLOCK::CLASS" +.PP +class definitions +.IP \(bu +.sp +\fIhandler_classes\fR +.RS +.IP [1] +CLASS \fBtextblock::class::table\fR +.RS +.sp +Create a table suitable for terminal output with various border styles\&. +.sp +The table can contain multiline cells and ANSI colour and text style attributes\&. +.sp +Multiple header rows can be configured\&. +.sp +Header rows can span columns - data rows cannot\&. +.sp +The restriction on data rows is to maintain compatibility of the data with a Tcl matrix command +.sp +(see get_matrix command) +.sp +Both header and data cells can have various text and blockalignments configured\&. +.sp +\fIMETHODS\fR +.TP +class::table \fBconstructor\fR \fIargs\fR +.sp +TODO - document the many options +.TP +class::table \fBconfigure\fR \fIargs\fR +.sp +get or set various table-level properties +.TP +class::table \fBprintmatrix\fR \fImatrix\fR +.sp +clear all table rows and print a matrix into the table +.sp +The rowxcolumn structure must match +.TP +class::table \fBas_matrix\fR \fI?cmd?\fR +.sp +return a struct::matrix command representing the data portion of the table\&. +.TP +class::table \fBadd_column\fR \fIargs\fR +.TP +class::table \fBcolumn_count\fR +.sp +return the number of columns +.TP +class::table \fBconfigure_column\fR \fIindex_expression\fR \fIargs\fR +.sp +- undocumented +.TP +class::table \fBheader_count\fR +.sp +return the number of header rows +.TP +class::table \fBheader_height\fR \fIheader_index\fR +.sp +return the height of a header as the number of content-lines +.TP +class::table \fBheader_colspans\fR +.sp +Show the colspans configured for all headers +.TP +class::table \fBconfigure_header\fR +.sp +- undocumented +.TP +class::table \fBadd_row\fR \fIvaluelist\fR ?\fB-minheight\fR \fIint_minheight\fR? ?\fB-maxheight\fR \fIint_maxheight\fR? ?\fB-ansibase\fR \fIansicode\fR? +.TP +class::table \fBconfigure_row\fR \fIindex_expression\fR ?\fB-minheight\fR \fIint_minheight\fR? ?\fB-maxheight\fR \fIint_maxheight\fR? ?\fB-ansibase\fR \fIansicode\fR? +.TP +class::table \fBrow_count\fR +.sp +return the number of data rows in the table\&. +.TP +class::table \fBrow_clear\fR +.sp +Remove all rows without resetting column data\&. +.sp +When adding new rows the number of entries will need to match the existing column count\&. +.TP +class::table \fBclear\fR +.sp +Remove all row and column data\&. +.sp +If a subsequent call to add_row is made it can contain any number of values\&. +.sp +Further calls to add_row will need to contain the same number of values +.sp +as the first call unless default values have been set for the missing columns (review - in flux)\&. +.TP +class::table \fBget_column_cells_by_index\fR \fIindex_expression\fR +.sp +Return a dict with keys 'headers' and 'cells' giving column header and data values +.TP +class::table \fBget_column_values_by_index\fR \fIindex_expression\fR +.sp +List the cell values of a column from the data area only (no header values) +.TP +class::table \fBdebug\fR +.sp +display lots of debug information about how the table is constructed\&. +.TP +class::table \fBcolumn_width\fR \fIindex_expression\fR +.sp +inner width of column ie the available cell-width without borders/separators +.TP +class::table \fBcolumn_width\fR +.sp +ordered list of column widths (inner widths) +.TP +class::table \fBwidth\fR +.sp +width of the table including borders and separators +.sp +calculate width based on assumption frame verticals are 1 screen-column wide +.sp +(review - consider possibility of custom unicode double-wide frame?) +.TP +class::table \fBspangroups\fR +.sp +return a dict keyed by column-index showing advanced span information +.sp +(debug tool) +.TP +class::table \fBprint\fR +.sp +Return the table as text suitable for console display +.TP +class::table \fBprint_bodymatrix\fR +.sp +output the matrix string corresponding to the body data using the matrix 2string format +.sp +this will be a table without borders,headers,title etc and will exclude additional ANSI applied due to table, row or column settings\&. +.sp +If the original cell data itself contains ANSI - the output will still contain those ansi codes\&. +.RE +.RE +.PP +Already uniform blocks will join faster than textblock::join, and ragged blocks will join in a ragged manner +" +Already uniform blocks will join faster than textblock::join, and ragged blocks will join in a ragged manner +" +.SH KEYWORDS +ansi, colour, console, frame, layout, module, table, terminal, text +.SH COPYRIGHT +.nf +Copyright (c) 2024 + +.fi diff --git a/src/embedded/man/files/_module_tomlish-1.1.1.tm.n b/src/embedded/man/files/_module_tomlish-1.1.1.tm.n index df27a892..d45bee9e 100644 --- a/src/embedded/man/files/_module_tomlish-1.1.1.tm.n +++ b/src/embedded/man/files/_module_tomlish-1.1.1.tm.n @@ -2,7 +2,7 @@ '\" Generated from file '_module_tomlish-1\&.1\&.1\&.tm\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2024 '\" -.TH "tomlish_module_tomlish" 0 1\&.1\&.1 doc "-" +.TH "tomlish_module_tomlish" 0 1\&.1\&.1 doc "tomlish" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" @@ -272,7 +272,7 @@ Database Class: \\fB\\$3\\fR .. .BS .SH NAME -tomlish_module_tomlish \- Module API +tomlish_module_tomlish \- tomlish toml parser .SH SYNOPSIS package require \fBtomlish \fR .sp @@ -287,7 +287,23 @@ app::\fBencoder\fR \fIargs\fR .BE .SH DESCRIPTION .PP -- +tomlish is an intermediate representation of toml data in a tree structure (tagged lists representing type information) +.PP +The design goals are for tomlish to be whitespace and comment preserving ie byte-for byte preservation during roundtrips from toml to tomlish and back to toml +.PP +The tomlish representation can then be converted to a Tcl dict structure or to other formats such as json, +.PP +although these other formats are generally unlikely to retain whitespace or comments +.PP +A further goal is to allow at least a useful subset of in-place editing operations which also preserve whitespace and comments\&. +.PP +e\&.g leaf key value editing, and table reordering/sorting, key-renaming at any level, key insertions/deletions +.PP +The API for editing (tomldoc object?) may require explicit setting of type if accessing an existing key +.PP +e\&.g setting a key that already exists and is a different type (especially if nested structure such as a table or array) +.PP +will need a -type option (-force ?) to force overriding with another type such as an int\&. .SH OVERVIEW .PP overview of tomlish @@ -303,10 +319,6 @@ packages used by tomlish \fBstruct::stack\fR .PP .SH API -.SS "NAMESPACE TOMLISH::CLASS" -.PP -class definitions -.PP .SS "NAMESPACE TOMLISH" .PP Core API functions for tomlish @@ -358,7 +370,7 @@ This encoder is intended to be compatible with toml-test Secondary functions that are part of the API .PP .SH KEYWORDS -module +configuration, module, parsing, toml .SH COPYRIGHT .nf Copyright (c) 2024 diff --git a/src/embedded/man/files/punk/_module_aliascore-0.1.0.tm.n b/src/embedded/man/files/punk/_module_aliascore-0.1.0.tm.n index 678b74ae..38721017 100644 --- a/src/embedded/man/files/punk/_module_aliascore-0.1.0.tm.n +++ b/src/embedded/man/files/punk/_module_aliascore-0.1.0.tm.n @@ -2,7 +2,7 @@ '\" Generated from file '_module_aliascore-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2024 '\" -.TH "shellspy_module_punk::aliascore" 0 0\&.1\&.0 doc "-" +.TH "punkshell_module_punk::aliascore" 0 0\&.1\&.0 doc "-" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" @@ -272,7 +272,7 @@ Database Class: \\fB\\$3\\fR .. .BS .SH NAME -shellspy_module_punk::aliascore \- Module API +punkshell_module_punk::aliascore \- punkshell command aliases .SH SYNOPSIS package require \fBpunk::aliascore \fR .sp @@ -306,7 +306,7 @@ Secondary functions that are part of the API .PP Internal functions that are not part of the API .SH KEYWORDS -module +alias, module .SH COPYRIGHT .nf Copyright (c) 2024 diff --git a/src/embedded/man/files/punk/_module_ansi-0.1.1.tm.n b/src/embedded/man/files/punk/_module_ansi-0.1.1.tm.n index 9afd0358..cb6a7c56 100644 --- a/src/embedded/man/files/punk/_module_ansi-0.1.1.tm.n +++ b/src/embedded/man/files/punk/_module_ansi-0.1.1.tm.n @@ -304,6 +304,8 @@ package require \fBpunk::ansi \fR .sp \fBmove_emit\fR \fIrow\fR \fIcol\fR \fIdata\fR ?row col data\&.\&.\&.? .sp +\fBmove_emitblock\fR \fIrow\fR \fIcol\fR \fItextblock\fR +.sp \fBmove_forward\fR \fIn\fR .sp \fBmove_back\fR \fIn\fR @@ -360,6 +362,8 @@ package require \fBpunk::ansi \fR .sp \fBansistrip\fR \fItext\fR .sp +\fBansistrip\fR \fItext\fR +.sp \fBansistripraw\fR \fItext\fR .sp \fBis_sgr_reset\fR \fIcode\fR @@ -510,6 +514,8 @@ punk::ansi::move_emit 10 10 blah {*}[punk::console::get_cursor_pos_list] DONE .sp A string created by any move_emit_return for punk::ansi would not behave in an intuitive manner compared to other punk::ansi move functions - so is deliberately omitted\&. .TP +\fBmove_emitblock\fR \fIrow\fR \fIcol\fR \fItextblock\fR +.TP \fBmove_forward\fR \fIn\fR .TP \fBmove_back\fR \fIn\fR @@ -631,6 +637,12 @@ Return a string with ansi codes stripped out .sp Alternate graphics chars are replaced with modern unicode equivalents (e\&.g boxdrawing glyphs) .TP +\fBansistrip\fR \fItext\fR +.sp +Return a string with ansi codes stripped out +.sp +Alternate graphics chars are replaced with modern unicode equivalents (e\&.g boxdrawing glyphs) +.TP \fBansistripraw\fR \fItext\fR .sp Return a string with ansi codes stripped out diff --git a/src/embedded/man/files/punk/_module_assertion-0.1.0.tm.n b/src/embedded/man/files/punk/_module_assertion-0.1.0.tm.n index 660eb950..fb95011e 100644 --- a/src/embedded/man/files/punk/_module_assertion-0.1.0.tm.n +++ b/src/embedded/man/files/punk/_module_assertion-0.1.0.tm.n @@ -2,7 +2,7 @@ '\" Generated from file '_module_assertion-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2024 '\" -.TH "shellspy_module_punk::assertion" 0 0\&.1\&.0 doc "per-namespace assertions with" +.TH "punkshell_module_punk::assertion" 0 0\&.1\&.0 doc "per-namespace assertions with" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" @@ -272,7 +272,7 @@ Database Class: \\fB\\$3\\fR .. .BS .SH NAME -shellspy_module_punk::assertion \- assertion alternative to control::assert +punkshell_module_punk::assertion \- assertion alternative to control::assert .SH SYNOPSIS package require \fBpunk::assertion \fR .sp diff --git a/src/embedded/man/files/punk/_module_basictelnet-0.1.0.tm.n b/src/embedded/man/files/punk/_module_basictelnet-0.1.0.tm.n index 0c0707e9..fa05c104 100644 --- a/src/embedded/man/files/punk/_module_basictelnet-0.1.0.tm.n +++ b/src/embedded/man/files/punk/_module_basictelnet-0.1.0.tm.n @@ -2,7 +2,7 @@ '\" Generated from file '_module_basictelnet-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2024 '\" -.TH "shellspy_module_punk::basictelnet" 0 0\&.1\&.0 doc "basic telnet client" +.TH "punkshell::basictelnet" 0 0\&.1\&.0 doc "basic telnet client" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" @@ -272,7 +272,7 @@ Database Class: \\fB\\$3\\fR .. .BS .SH NAME -shellspy_module_punk::basictelnet \- basic telnet client - DKF/Wiki +punkshell::basictelnet \- basic telnet client - DKF/Wiki .SH SYNOPSIS package require \fBpunk::basictelnet \fR .sp @@ -310,7 +310,7 @@ Secondary functions that are part of the API .PP Internal functions that are not part of the API .SH KEYWORDS -module +console, module, protocol, telnet, terminal .SH COPYRIGHT .nf Copyright (c) 2024 diff --git a/src/embedded/man/files/punk/_module_blockletter-0.1.0.tm.n b/src/embedded/man/files/punk/_module_blockletter-0.1.0.tm.n new file mode 100644 index 00000000..eabe6664 --- /dev/null +++ b/src/embedded/man/files/punk/_module_blockletter-0.1.0.tm.n @@ -0,0 +1,329 @@ +'\" +'\" Generated from file '_module_blockletter-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' +'\" Copyright (c) 2024 +'\" +.TH "punkshell_module_punk::blockletter" 0 0\&.1\&.0 doc "-" +.\" The -*- nroff -*- definitions below are for supplemental macros used +.\" in Tcl/Tk manual entries. +.\" +.\" .AP type name in/out ?indent? +.\" Start paragraph describing an argument to a library procedure. +.\" type is type of argument (int, etc.), in/out is either "in", "out", +.\" or "in/out" to describe whether procedure reads or modifies arg, +.\" and indent is equivalent to second arg of .IP (shouldn't ever be +.\" needed; use .AS below instead) +.\" +.\" .AS ?type? ?name? +.\" Give maximum sizes of arguments for setting tab stops. Type and +.\" name are examples of largest possible arguments that will be passed +.\" to .AP later. If args are omitted, default tab stops are used. +.\" +.\" .BS +.\" Start box enclosure. From here until next .BE, everything will be +.\" enclosed in one large box. +.\" +.\" .BE +.\" End of box enclosure. +.\" +.\" .CS +.\" Begin code excerpt. +.\" +.\" .CE +.\" End code excerpt. +.\" +.\" .VS ?version? ?br? +.\" Begin vertical sidebar, for use in marking newly-changed parts +.\" of man pages. The first argument is ignored and used for recording +.\" the version when the .VS was added, so that the sidebars can be +.\" found and removed when they reach a certain age. If another argument +.\" is present, then a line break is forced before starting the sidebar. +.\" +.\" .VE +.\" End of vertical sidebar. +.\" +.\" .DS +.\" Begin an indented unfilled display. +.\" +.\" .DE +.\" End of indented unfilled display. +.\" +.\" .SO ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three columns separated by tabs. +.\" +.\" .SE +.\" End of list of standard options for a Tk widget. +.\" +.\" .OP cmdName dbName dbClass +.\" Start of description of a specific option. cmdName gives the +.\" option's name as specified in the class command, dbName gives +.\" the option's name in the option database, and dbClass gives +.\" the option's class in the option database. +.\" +.\" .UL arg1 arg2 +.\" Print arg1 underlined, then print arg2 normally. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. +.if t .wh -1.3i ^B +.nr ^l \n(.l +.ad b +.\" # Start an argument description +.de AP +.ie !"\\$4"" .TP \\$4 +.el \{\ +. ie !"\\$2"" .TP \\n()Cu +. el .TP 15 +.\} +.ta \\n()Au \\n()Bu +.ie !"\\$3"" \{\ +\&\\$1 \\fI\\$2\\fP (\\$3) +.\".b +.\} +.el \{\ +.br +.ie !"\\$2"" \{\ +\&\\$1 \\fI\\$2\\fP +.\} +.el \{\ +\&\\fI\\$1\\fP +.\} +.\} +.. +.\" # define tabbing values for .AP +.de AS +.nr )A 10n +.if !"\\$1"" .nr )A \\w'\\$1'u+3n +.nr )B \\n()Au+15n +.\" +.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n +.nr )C \\n()Bu+\\w'(in/out)'u+2n +.. +.AS Tcl_Interp Tcl_CreateInterp in/out +.\" # BS - start boxed text +.\" # ^y = starting y location +.\" # ^b = 1 +.de BS +.br +.mk ^y +.nr ^b 1u +.if n .nf +.if n .ti 0 +.if n \l'\\n(.lu\(ul' +.if n .fi +.. +.\" # BE - end boxed text (draw box now) +.de BE +.nf +.ti 0 +.mk ^t +.ie n \l'\\n(^lu\(ul' +.el \{\ +.\" Draw four-sided box normally, but don't draw top of +.\" box if the box started on an earlier page. +.ie !\\n(^b-1 \{\ +\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' +.\} +.el \}\ +\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' +.\} +.\} +.fi +.br +.nr ^b 0 +.. +.\" # VS - start vertical sidebar +.\" # ^Y = starting y location +.\" # ^v = 1 (for troff; for nroff this doesn't matter) +.de VS +.if !"\\$2"" .br +.mk ^Y +.ie n 'mc \s12\(br\s0 +.el .nr ^v 1u +.. +.\" # VE - end of vertical sidebar +.de VE +.ie n 'mc +.el \{\ +.ev 2 +.nf +.ti 0 +.mk ^t +\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' +.sp -1 +.fi +.ev +.\} +.nr ^v 0 +.. +.\" # Special macro to handle page bottom: finish off current +.\" # box/sidebar if in box/sidebar mode, then invoked standard +.\" # page bottom macro. +.de ^B +.ev 2 +'ti 0 +'nf +.mk ^t +.if \\n(^b \{\ +.\" Draw three-sided box if this is the box's first page, +.\" draw two sides but no top otherwise. +.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c +.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c +.\} +.if \\n(^v \{\ +.nr ^x \\n(^tu+1v-\\n(^Yu +\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c +.\} +.bp +'fi +.ev +.if \\n(^b \{\ +.mk ^y +.nr ^b 2 +.\} +.if \\n(^v \{\ +.mk ^Y +.\} +.. +.\" # DS - begin display +.de DS +.RS +.nf +.sp +.. +.\" # DE - end display +.de DE +.fi +.RE +.sp +.. +.\" # SO - start of list of standard options +.de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR +.SH "STANDARD OPTIONS" +.LP +.nf +.ta 5.5c 11c +.ft B +.. +.\" # SE - end of list of standard options +.de SE +.fi +.ft R +.LP +See the \\*(So manual entry for details on the standard options. +.. +.\" # OP - start of full description for a single option +.de OP +.LP +.nf +.ta 4c +Command-Line Name: \\fB\\$1\\fR +Database Name: \\fB\\$2\\fR +Database Class: \\fB\\$3\\fR +.fi +.IP +.. +.\" # CS - begin code excerpt +.de CS +.RS +.nf +.ta .25i .5i .75i 1i +.. +.\" # CE - end code excerpt +.de CE +.fi +.RE +.. +.\" # UL - underline word +.de UL +\\$1\l'|0\(ul'\\$2 +.. +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. +.BS +.SH NAME +punkshell_module_punk::blockletter \- punk::blockletter frame-based large lettering test/logo +.SH SYNOPSIS +package require \fBpunk::blockletter \fR +.sp +.BE +.SH DESCRIPTION +.PP +This is primarily designed to test large lettering using the block2 frametype which requires the right font support +.PP +More reasonably sized block-lettering could be obtained using unicode half-blocks instead - but that doesn't allow the frame outline effect that block2 gives\&. +.PP +Individual blocks have a minimum width of 4 columns and a minimum height of 2 rows (smallest element that can be fully framed) +.SH OVERVIEW +.PP +overview of punk::blockletter +.SS CONCEPTS +.PP +- +.SS DEPENDENCIES +.PP +packages used by punk::blockletter +.IP \(bu +\fBTcl 8\&.6\fR +.IP \(bu +\fBtextblock\fR +.PP +.SH API +.SS "NAMESPACE PUNK::BLOCKLETTER::CLASS" +.PP +class definitions +if { eq ""} { +.PP +} +} +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +.SS "NAMESPACE PUNK::BLOCKLETTER" +.PP +Core API functions for punk::blockletter +.PP +.SS "NAMESPACE PUNK::BLOCKLETTER::LIB" +.PP +Secondary functions that are part of the API +.PP +.SH INTERNAL +tcl::namespace::eval punk::blockletter::system { +.SS "NAMESPACE PUNK::BLOCKLETTER::SYSTEM" +.PP +Internal functions that are not part of the API +.SH KEYWORDS +module +.SH COPYRIGHT +.nf +Copyright (c) 2024 + +.fi diff --git a/src/embedded/man/files/punk/_module_cesu-0.1.0.tm.n b/src/embedded/man/files/punk/_module_cesu-0.1.0.tm.n new file mode 100644 index 00000000..49219f5e --- /dev/null +++ b/src/embedded/man/files/punk/_module_cesu-0.1.0.tm.n @@ -0,0 +1,319 @@ +'\" +'\" Generated from file '_module_cesu-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' +'\" Copyright (c) 2024 +'\" +.TH "punkshell_module_punk::cesu" 0 0\&.1\&.0 doc "CESU experimental" +.\" The -*- nroff -*- definitions below are for supplemental macros used +.\" in Tcl/Tk manual entries. +.\" +.\" .AP type name in/out ?indent? +.\" Start paragraph describing an argument to a library procedure. +.\" type is type of argument (int, etc.), in/out is either "in", "out", +.\" or "in/out" to describe whether procedure reads or modifies arg, +.\" and indent is equivalent to second arg of .IP (shouldn't ever be +.\" needed; use .AS below instead) +.\" +.\" .AS ?type? ?name? +.\" Give maximum sizes of arguments for setting tab stops. Type and +.\" name are examples of largest possible arguments that will be passed +.\" to .AP later. If args are omitted, default tab stops are used. +.\" +.\" .BS +.\" Start box enclosure. From here until next .BE, everything will be +.\" enclosed in one large box. +.\" +.\" .BE +.\" End of box enclosure. +.\" +.\" .CS +.\" Begin code excerpt. +.\" +.\" .CE +.\" End code excerpt. +.\" +.\" .VS ?version? ?br? +.\" Begin vertical sidebar, for use in marking newly-changed parts +.\" of man pages. The first argument is ignored and used for recording +.\" the version when the .VS was added, so that the sidebars can be +.\" found and removed when they reach a certain age. If another argument +.\" is present, then a line break is forced before starting the sidebar. +.\" +.\" .VE +.\" End of vertical sidebar. +.\" +.\" .DS +.\" Begin an indented unfilled display. +.\" +.\" .DE +.\" End of indented unfilled display. +.\" +.\" .SO ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three columns separated by tabs. +.\" +.\" .SE +.\" End of list of standard options for a Tk widget. +.\" +.\" .OP cmdName dbName dbClass +.\" Start of description of a specific option. cmdName gives the +.\" option's name as specified in the class command, dbName gives +.\" the option's name in the option database, and dbClass gives +.\" the option's class in the option database. +.\" +.\" .UL arg1 arg2 +.\" Print arg1 underlined, then print arg2 normally. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. +.if t .wh -1.3i ^B +.nr ^l \n(.l +.ad b +.\" # Start an argument description +.de AP +.ie !"\\$4"" .TP \\$4 +.el \{\ +. ie !"\\$2"" .TP \\n()Cu +. el .TP 15 +.\} +.ta \\n()Au \\n()Bu +.ie !"\\$3"" \{\ +\&\\$1 \\fI\\$2\\fP (\\$3) +.\".b +.\} +.el \{\ +.br +.ie !"\\$2"" \{\ +\&\\$1 \\fI\\$2\\fP +.\} +.el \{\ +\&\\fI\\$1\\fP +.\} +.\} +.. +.\" # define tabbing values for .AP +.de AS +.nr )A 10n +.if !"\\$1"" .nr )A \\w'\\$1'u+3n +.nr )B \\n()Au+15n +.\" +.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n +.nr )C \\n()Bu+\\w'(in/out)'u+2n +.. +.AS Tcl_Interp Tcl_CreateInterp in/out +.\" # BS - start boxed text +.\" # ^y = starting y location +.\" # ^b = 1 +.de BS +.br +.mk ^y +.nr ^b 1u +.if n .nf +.if n .ti 0 +.if n \l'\\n(.lu\(ul' +.if n .fi +.. +.\" # BE - end boxed text (draw box now) +.de BE +.nf +.ti 0 +.mk ^t +.ie n \l'\\n(^lu\(ul' +.el \{\ +.\" Draw four-sided box normally, but don't draw top of +.\" box if the box started on an earlier page. +.ie !\\n(^b-1 \{\ +\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' +.\} +.el \}\ +\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' +.\} +.\} +.fi +.br +.nr ^b 0 +.. +.\" # VS - start vertical sidebar +.\" # ^Y = starting y location +.\" # ^v = 1 (for troff; for nroff this doesn't matter) +.de VS +.if !"\\$2"" .br +.mk ^Y +.ie n 'mc \s12\(br\s0 +.el .nr ^v 1u +.. +.\" # VE - end of vertical sidebar +.de VE +.ie n 'mc +.el \{\ +.ev 2 +.nf +.ti 0 +.mk ^t +\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' +.sp -1 +.fi +.ev +.\} +.nr ^v 0 +.. +.\" # Special macro to handle page bottom: finish off current +.\" # box/sidebar if in box/sidebar mode, then invoked standard +.\" # page bottom macro. +.de ^B +.ev 2 +'ti 0 +'nf +.mk ^t +.if \\n(^b \{\ +.\" Draw three-sided box if this is the box's first page, +.\" draw two sides but no top otherwise. +.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c +.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c +.\} +.if \\n(^v \{\ +.nr ^x \\n(^tu+1v-\\n(^Yu +\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c +.\} +.bp +'fi +.ev +.if \\n(^b \{\ +.mk ^y +.nr ^b 2 +.\} +.if \\n(^v \{\ +.mk ^Y +.\} +.. +.\" # DS - begin display +.de DS +.RS +.nf +.sp +.. +.\" # DE - end display +.de DE +.fi +.RE +.sp +.. +.\" # SO - start of list of standard options +.de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR +.SH "STANDARD OPTIONS" +.LP +.nf +.ta 5.5c 11c +.ft B +.. +.\" # SE - end of list of standard options +.de SE +.fi +.ft R +.LP +See the \\*(So manual entry for details on the standard options. +.. +.\" # OP - start of full description for a single option +.de OP +.LP +.nf +.ta 4c +Command-Line Name: \\fB\\$1\\fR +Database Name: \\fB\\$2\\fR +Database Class: \\fB\\$3\\fR +.fi +.IP +.. +.\" # CS - begin code excerpt +.de CS +.RS +.nf +.ta .25i .5i .75i 1i +.. +.\" # CE - end code excerpt +.de CE +.fi +.RE +.. +.\" # UL - underline word +.de UL +\\$1\l'|0\(ul'\\$2 +.. +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. +.BS +.SH NAME +punkshell_module_punk::cesu \- CESU compatibility ehcoding scheme for utf-16: 8-Bit (CESU-8) ?? +.SH SYNOPSIS +package require \fBpunk::cesu \fR +.sp +.BE +.SH DESCRIPTION +.PP +experimental +.SH OVERVIEW +.PP +overview of punk::cesu +.SS CONCEPTS +.PP +cesu-8 may be mistaken for utf-8 if no supplementary chars present\&. +.PP +see: https://www\&.unicode\&.org/reports/tr26/tr26-4\&.html +.PP +Particulary note discouragement of use especially in external interchange\&. +.SS DEPENDENCIES +.PP +packages used by punk::cesu +.IP \(bu +\fBTcl 8\&.6\fR +.PP +.SH API +.SS "NAMESPACE PUNK::CESU" +.PP +Core API functions for punk::cesu +.PP +.SS "NAMESPACE PUNK::CESU::LIB" +.PP +Secondary functions that are part of the API +.PP +.SH INTERNAL +tcl::namespace::eval punk::cesu::system { +.SS "NAMESPACE PUNK::CESU::SYSTEM" +.PP +Internal functions that are not part of the API +.SH KEYWORDS +cesu, compatibility, encoding, experimental, module, unofficial +.SH COPYRIGHT +.nf +Copyright (c) 2024 + +.fi diff --git a/src/embedded/man/files/punk/_module_experiment-0.1.0.tm.n b/src/embedded/man/files/punk/_module_experiment-0.1.0.tm.n index 533cddb0..7f101036 100644 --- a/src/embedded/man/files/punk/_module_experiment-0.1.0.tm.n +++ b/src/embedded/man/files/punk/_module_experiment-0.1.0.tm.n @@ -2,7 +2,7 @@ '\" Generated from file '_module_experiment-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2024 '\" -.TH "shellspy_module_punk::experiment" 0 0\&.1\&.0 doc "-" +.TH "punkshell_module_punk::experiment" 0 0\&.1\&.0 doc "-" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" @@ -272,7 +272,7 @@ Database Class: \\fB\\$3\\fR .. .BS .SH NAME -shellspy_module_punk::experiment \- Module API +punkshell_module_punk::experiment \- Module API .SH SYNOPSIS package require \fBpunk::experiment \fR .sp diff --git a/src/embedded/man/files/punk/_module_island-0.1.0.tm.n b/src/embedded/man/files/punk/_module_island-0.1.0.tm.n index 73b37424..09dcc7f0 100644 --- a/src/embedded/man/files/punk/_module_island-0.1.0.tm.n +++ b/src/embedded/man/files/punk/_module_island-0.1.0.tm.n @@ -2,7 +2,7 @@ '\" Generated from file '_module_island-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2024 '\" -.TH "shellspy_module_punk::island" 0 0\&.1\&.0 doc "punk::island for safe interps" +.TH "punkshell_module_punk::island" 0 0\&.1\&.0 doc "punk::island for safe interps" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" @@ -272,7 +272,7 @@ Database Class: \\fB\\$3\\fR .. .BS .SH NAME -shellspy_module_punk::island \- filesystem islands for safe interps +punkshell_module_punk::island \- filesystem islands for safe interps .SH SYNOPSIS package require \fBpunk::island \fR .sp diff --git a/src/embedded/man/files/punk/_module_lib-0.1.1.tm.n b/src/embedded/man/files/punk/_module_lib-0.1.1.tm.n index f71fd266..8defc874 100644 --- a/src/embedded/man/files/punk/_module_lib-0.1.1.tm.n +++ b/src/embedded/man/files/punk/_module_lib-0.1.1.tm.n @@ -284,6 +284,8 @@ package require \fBpunk::lib \fR .sp \fBlindex_resolve\fR \fIlist\fR \fIindex\fR .sp +\fBlindex_resolve_basic\fR \fIlist\fR \fIindex\fR +.sp \fBK\fR \fIx\fR \fIy\fR .sp \fBis_utf8_multibyteprefix\fR \fIstr\fR @@ -404,15 +406,33 @@ We want to resolve the index used, without passing arbitrary expressions into th .sp lindex_resolve will parse the index expression and return: .sp -a) -2 if the supplied index expression is below the lower bound for the supplied list\&. (< 0) +a) -3 if the supplied index expression is below the lower bound for the supplied list\&. (< 0) +.sp +b) -2 if the supplied index expression is above the upper bound for the supplied list\&. (> end) .sp -b) -1 if the supplied index expression is above the upper bound for the supplied list\&. (> end) +We don't return -1 - as the similar function lindex_resolve_basic uses this to denote out of range at either end of the list .sp Otherwise it will return an integer corresponding to the position in the list\&. .sp This is in stark contrast to Tcl list function indices which will return empty strings for out or bounds indices, or in the case of lrange, return results anyway\&. .sp Like Tcl list commands - it will produce an error if the form of the index is not acceptable +.sp +For empty lists, end and end+x indices are considered to be out of bounds on the upper side - thus returning -2 +.TP +\fBlindex_resolve_basic\fR \fIlist\fR \fIindex\fR +.sp +Accepts index of the forms accepted by Tcl's list commands\&. (e\&.g compound indices such as 3+1 end-2) +.sp +returns -1 for out of range at either end, or a valid integer index +.sp +Unlike lindex_resolve; lindex_resolve_basic can't determine if an out of range index was out of range at the lower or upper bound +.sp +This is only likely to be faster than average over lindex_resolve for Tcl which has the builtin lseq command +.sp +The performance advantage is more likely to be present when using compound indexes such as $x+1 or end-1 +.sp +For pure integer indices the performance should be equivalent .TP \fBK\fR \fIx\fR \fIy\fR .sp diff --git a/src/embedded/man/files/punk/_module_packagepreference-0.1.0.tm.n b/src/embedded/man/files/punk/_module_packagepreference-0.1.0.tm.n index 0c209221..76e6b228 100644 --- a/src/embedded/man/files/punk/_module_packagepreference-0.1.0.tm.n +++ b/src/embedded/man/files/punk/_module_packagepreference-0.1.0.tm.n @@ -2,7 +2,7 @@ '\" Generated from file '_module_packagepreference-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2024 '\" -.TH "shellspy_module_punk::packagepreference" 0 0\&.1\&.0 doc "-" +.TH "punkshell_module_punk::packagepreference" 0 0\&.1\&.0 doc "package/module load" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" @@ -272,7 +272,7 @@ Database Class: \\fB\\$3\\fR .. .BS .SH NAME -shellspy_module_punk::packagepreference \- Module API +punkshell_module_punk::packagepreference \- punkshell package/module loading .SH SYNOPSIS package require \fBpunk::packagepreference \fR .sp @@ -345,7 +345,7 @@ tcl::namespace::eval punk::packagepreference::system { .PP Internal functions that are not part of the API .SH KEYWORDS -module +module, package .SH COPYRIGHT .nf Copyright (c) 2024 diff --git a/src/embedded/man/files/punk/_module_rest-0.1.0.tm.n b/src/embedded/man/files/punk/_module_rest-0.1.0.tm.n new file mode 100644 index 00000000..6bfda8d5 --- /dev/null +++ b/src/embedded/man/files/punk/_module_rest-0.1.0.tm.n @@ -0,0 +1,323 @@ +'\" +'\" Generated from file '_module_rest-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' +'\" Copyright (c) 2024 +'\" +.TH "punkshell_module_punk::rest" 0 0\&.1\&.0 doc "experimental rest" +.\" The -*- nroff -*- definitions below are for supplemental macros used +.\" in Tcl/Tk manual entries. +.\" +.\" .AP type name in/out ?indent? +.\" Start paragraph describing an argument to a library procedure. +.\" type is type of argument (int, etc.), in/out is either "in", "out", +.\" or "in/out" to describe whether procedure reads or modifies arg, +.\" and indent is equivalent to second arg of .IP (shouldn't ever be +.\" needed; use .AS below instead) +.\" +.\" .AS ?type? ?name? +.\" Give maximum sizes of arguments for setting tab stops. Type and +.\" name are examples of largest possible arguments that will be passed +.\" to .AP later. If args are omitted, default tab stops are used. +.\" +.\" .BS +.\" Start box enclosure. From here until next .BE, everything will be +.\" enclosed in one large box. +.\" +.\" .BE +.\" End of box enclosure. +.\" +.\" .CS +.\" Begin code excerpt. +.\" +.\" .CE +.\" End code excerpt. +.\" +.\" .VS ?version? ?br? +.\" Begin vertical sidebar, for use in marking newly-changed parts +.\" of man pages. The first argument is ignored and used for recording +.\" the version when the .VS was added, so that the sidebars can be +.\" found and removed when they reach a certain age. If another argument +.\" is present, then a line break is forced before starting the sidebar. +.\" +.\" .VE +.\" End of vertical sidebar. +.\" +.\" .DS +.\" Begin an indented unfilled display. +.\" +.\" .DE +.\" End of indented unfilled display. +.\" +.\" .SO ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three columns separated by tabs. +.\" +.\" .SE +.\" End of list of standard options for a Tk widget. +.\" +.\" .OP cmdName dbName dbClass +.\" Start of description of a specific option. cmdName gives the +.\" option's name as specified in the class command, dbName gives +.\" the option's name in the option database, and dbClass gives +.\" the option's class in the option database. +.\" +.\" .UL arg1 arg2 +.\" Print arg1 underlined, then print arg2 normally. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. +.if t .wh -1.3i ^B +.nr ^l \n(.l +.ad b +.\" # Start an argument description +.de AP +.ie !"\\$4"" .TP \\$4 +.el \{\ +. ie !"\\$2"" .TP \\n()Cu +. el .TP 15 +.\} +.ta \\n()Au \\n()Bu +.ie !"\\$3"" \{\ +\&\\$1 \\fI\\$2\\fP (\\$3) +.\".b +.\} +.el \{\ +.br +.ie !"\\$2"" \{\ +\&\\$1 \\fI\\$2\\fP +.\} +.el \{\ +\&\\fI\\$1\\fP +.\} +.\} +.. +.\" # define tabbing values for .AP +.de AS +.nr )A 10n +.if !"\\$1"" .nr )A \\w'\\$1'u+3n +.nr )B \\n()Au+15n +.\" +.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n +.nr )C \\n()Bu+\\w'(in/out)'u+2n +.. +.AS Tcl_Interp Tcl_CreateInterp in/out +.\" # BS - start boxed text +.\" # ^y = starting y location +.\" # ^b = 1 +.de BS +.br +.mk ^y +.nr ^b 1u +.if n .nf +.if n .ti 0 +.if n \l'\\n(.lu\(ul' +.if n .fi +.. +.\" # BE - end boxed text (draw box now) +.de BE +.nf +.ti 0 +.mk ^t +.ie n \l'\\n(^lu\(ul' +.el \{\ +.\" Draw four-sided box normally, but don't draw top of +.\" box if the box started on an earlier page. +.ie !\\n(^b-1 \{\ +\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' +.\} +.el \}\ +\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' +.\} +.\} +.fi +.br +.nr ^b 0 +.. +.\" # VS - start vertical sidebar +.\" # ^Y = starting y location +.\" # ^v = 1 (for troff; for nroff this doesn't matter) +.de VS +.if !"\\$2"" .br +.mk ^Y +.ie n 'mc \s12\(br\s0 +.el .nr ^v 1u +.. +.\" # VE - end of vertical sidebar +.de VE +.ie n 'mc +.el \{\ +.ev 2 +.nf +.ti 0 +.mk ^t +\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' +.sp -1 +.fi +.ev +.\} +.nr ^v 0 +.. +.\" # Special macro to handle page bottom: finish off current +.\" # box/sidebar if in box/sidebar mode, then invoked standard +.\" # page bottom macro. +.de ^B +.ev 2 +'ti 0 +'nf +.mk ^t +.if \\n(^b \{\ +.\" Draw three-sided box if this is the box's first page, +.\" draw two sides but no top otherwise. +.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c +.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c +.\} +.if \\n(^v \{\ +.nr ^x \\n(^tu+1v-\\n(^Yu +\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c +.\} +.bp +'fi +.ev +.if \\n(^b \{\ +.mk ^y +.nr ^b 2 +.\} +.if \\n(^v \{\ +.mk ^Y +.\} +.. +.\" # DS - begin display +.de DS +.RS +.nf +.sp +.. +.\" # DE - end display +.de DE +.fi +.RE +.sp +.. +.\" # SO - start of list of standard options +.de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR +.SH "STANDARD OPTIONS" +.LP +.nf +.ta 5.5c 11c +.ft B +.. +.\" # SE - end of list of standard options +.de SE +.fi +.ft R +.LP +See the \\*(So manual entry for details on the standard options. +.. +.\" # OP - start of full description for a single option +.de OP +.LP +.nf +.ta 4c +Command-Line Name: \\fB\\$1\\fR +Database Name: \\fB\\$2\\fR +Database Class: \\fB\\$3\\fR +.fi +.IP +.. +.\" # CS - begin code excerpt +.de CS +.RS +.nf +.ta .25i .5i .75i 1i +.. +.\" # CE - end code excerpt +.de CE +.fi +.RE +.. +.\" # UL - underline word +.de UL +\\$1\l'|0\(ul'\\$2 +.. +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. +.BS +.SH NAME +punkshell_module_punk::rest \- punk::rest +.SH SYNOPSIS +package require \fBpunk::rest \fR +.sp +.BE +.SH DESCRIPTION +.PP +Experimental *basic rest as wrapper over http lib - use tcllib's rest package for a more complete implementation of a rest client +.SH OVERVIEW +.PP +overview of punk::rest +.SS CONCEPTS +.PP +- +.SS DEPENDENCIES +.PP +packages used by punk::rest +.IP \(bu +\fBTcl 8\&.6\fR +.PP +.SH API +.SS "NAMESPACE PUNK::REST::CLASS" +.PP +class definitions +if { eq ""} { +.PP +} +} +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +.SS "NAMESPACE PUNK::REST" +.PP +Core API functions for punk::rest +.PP +.SS "NAMESPACE PUNK::REST::LIB" +.PP +Secondary functions that are part of the API +.PP +.SH INTERNAL +tcl::namespace::eval punk::rest::system { +.SS "NAMESPACE PUNK::REST::SYSTEM" +.PP +Internal functions that are not part of the API +.SH KEYWORDS +http, module, rest +.SH COPYRIGHT +.nf +Copyright (c) 2024 + +.fi diff --git a/src/embedded/man/files/punk/_module_sshrun-0.1.0.tm.n b/src/embedded/man/files/punk/_module_sshrun-0.1.0.tm.n index f87a5615..334abd63 100644 --- a/src/embedded/man/files/punk/_module_sshrun-0.1.0.tm.n +++ b/src/embedded/man/files/punk/_module_sshrun-0.1.0.tm.n @@ -2,7 +2,7 @@ '\" Generated from file '_module_sshrun-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009 '\" -.TH "shellspy_module_punk::sshrun" 0 0\&.1\&.0 doc "punk::sshrun tclssh clone" +.TH "punkshell_module_punk::sshrun" 0 0\&.1\&.0 doc "punk::sshrun tclssh clone" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" @@ -272,7 +272,7 @@ Database Class: \\fB\\$3\\fR .. .BS .SH NAME -shellspy_module_punk::sshrun \- Tcl procedures to execute tcl scripts in remote hosts +punkshell_module_punk::sshrun \- Tcl procedures to execute tcl scripts in remote hosts .SH SYNOPSIS package require \fBpunk::sshrun \fR .sp diff --git a/src/embedded/man/files/punk/_module_trie-0.1.0.tm.n b/src/embedded/man/files/punk/_module_trie-0.1.0.tm.n new file mode 100644 index 00000000..a2306233 --- /dev/null +++ b/src/embedded/man/files/punk/_module_trie-0.1.0.tm.n @@ -0,0 +1,325 @@ +'\" +'\" Generated from file '_module_trie-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' +'\" Copyright (c) 2010 +'\" +.TH "punkshell_module_punk::trie" 0 0\&.1\&.0 doc "punk::trie" +.\" The -*- nroff -*- definitions below are for supplemental macros used +.\" in Tcl/Tk manual entries. +.\" +.\" .AP type name in/out ?indent? +.\" Start paragraph describing an argument to a library procedure. +.\" type is type of argument (int, etc.), in/out is either "in", "out", +.\" or "in/out" to describe whether procedure reads or modifies arg, +.\" and indent is equivalent to second arg of .IP (shouldn't ever be +.\" needed; use .AS below instead) +.\" +.\" .AS ?type? ?name? +.\" Give maximum sizes of arguments for setting tab stops. Type and +.\" name are examples of largest possible arguments that will be passed +.\" to .AP later. If args are omitted, default tab stops are used. +.\" +.\" .BS +.\" Start box enclosure. From here until next .BE, everything will be +.\" enclosed in one large box. +.\" +.\" .BE +.\" End of box enclosure. +.\" +.\" .CS +.\" Begin code excerpt. +.\" +.\" .CE +.\" End code excerpt. +.\" +.\" .VS ?version? ?br? +.\" Begin vertical sidebar, for use in marking newly-changed parts +.\" of man pages. The first argument is ignored and used for recording +.\" the version when the .VS was added, so that the sidebars can be +.\" found and removed when they reach a certain age. If another argument +.\" is present, then a line break is forced before starting the sidebar. +.\" +.\" .VE +.\" End of vertical sidebar. +.\" +.\" .DS +.\" Begin an indented unfilled display. +.\" +.\" .DE +.\" End of indented unfilled display. +.\" +.\" .SO ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three columns separated by tabs. +.\" +.\" .SE +.\" End of list of standard options for a Tk widget. +.\" +.\" .OP cmdName dbName dbClass +.\" Start of description of a specific option. cmdName gives the +.\" option's name as specified in the class command, dbName gives +.\" the option's name in the option database, and dbClass gives +.\" the option's class in the option database. +.\" +.\" .UL arg1 arg2 +.\" Print arg1 underlined, then print arg2 normally. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. +.if t .wh -1.3i ^B +.nr ^l \n(.l +.ad b +.\" # Start an argument description +.de AP +.ie !"\\$4"" .TP \\$4 +.el \{\ +. ie !"\\$2"" .TP \\n()Cu +. el .TP 15 +.\} +.ta \\n()Au \\n()Bu +.ie !"\\$3"" \{\ +\&\\$1 \\fI\\$2\\fP (\\$3) +.\".b +.\} +.el \{\ +.br +.ie !"\\$2"" \{\ +\&\\$1 \\fI\\$2\\fP +.\} +.el \{\ +\&\\fI\\$1\\fP +.\} +.\} +.. +.\" # define tabbing values for .AP +.de AS +.nr )A 10n +.if !"\\$1"" .nr )A \\w'\\$1'u+3n +.nr )B \\n()Au+15n +.\" +.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n +.nr )C \\n()Bu+\\w'(in/out)'u+2n +.. +.AS Tcl_Interp Tcl_CreateInterp in/out +.\" # BS - start boxed text +.\" # ^y = starting y location +.\" # ^b = 1 +.de BS +.br +.mk ^y +.nr ^b 1u +.if n .nf +.if n .ti 0 +.if n \l'\\n(.lu\(ul' +.if n .fi +.. +.\" # BE - end boxed text (draw box now) +.de BE +.nf +.ti 0 +.mk ^t +.ie n \l'\\n(^lu\(ul' +.el \{\ +.\" Draw four-sided box normally, but don't draw top of +.\" box if the box started on an earlier page. +.ie !\\n(^b-1 \{\ +\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' +.\} +.el \}\ +\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' +.\} +.\} +.fi +.br +.nr ^b 0 +.. +.\" # VS - start vertical sidebar +.\" # ^Y = starting y location +.\" # ^v = 1 (for troff; for nroff this doesn't matter) +.de VS +.if !"\\$2"" .br +.mk ^Y +.ie n 'mc \s12\(br\s0 +.el .nr ^v 1u +.. +.\" # VE - end of vertical sidebar +.de VE +.ie n 'mc +.el \{\ +.ev 2 +.nf +.ti 0 +.mk ^t +\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' +.sp -1 +.fi +.ev +.\} +.nr ^v 0 +.. +.\" # Special macro to handle page bottom: finish off current +.\" # box/sidebar if in box/sidebar mode, then invoked standard +.\" # page bottom macro. +.de ^B +.ev 2 +'ti 0 +'nf +.mk ^t +.if \\n(^b \{\ +.\" Draw three-sided box if this is the box's first page, +.\" draw two sides but no top otherwise. +.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c +.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c +.\} +.if \\n(^v \{\ +.nr ^x \\n(^tu+1v-\\n(^Yu +\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c +.\} +.bp +'fi +.ev +.if \\n(^b \{\ +.mk ^y +.nr ^b 2 +.\} +.if \\n(^v \{\ +.mk ^Y +.\} +.. +.\" # DS - begin display +.de DS +.RS +.nf +.sp +.. +.\" # DE - end display +.de DE +.fi +.RE +.sp +.. +.\" # SO - start of list of standard options +.de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR +.SH "STANDARD OPTIONS" +.LP +.nf +.ta 5.5c 11c +.ft B +.. +.\" # SE - end of list of standard options +.de SE +.fi +.ft R +.LP +See the \\*(So manual entry for details on the standard options. +.. +.\" # OP - start of full description for a single option +.de OP +.LP +.nf +.ta 4c +Command-Line Name: \\fB\\$1\\fR +Database Name: \\fB\\$2\\fR +Database Class: \\fB\\$3\\fR +.fi +.IP +.. +.\" # CS - begin code excerpt +.de CS +.RS +.nf +.ta .25i .5i .75i 1i +.. +.\" # CE - end code excerpt +.de CE +.fi +.RE +.. +.\" # UL - underline word +.de UL +\\$1\l'|0\(ul'\\$2 +.. +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. +.BS +.SH NAME +punkshell_module_punk::trie \- punk::trie API +.SH SYNOPSIS +package require \fBpunk::trie \fR +.sp +class::trieclass \fBmatches\fR \fIt\fR \fIwhat\fR +.sp +.BE +.SH DESCRIPTION tcl trie implementation courtesy of CmcC (tcl wiki) +.PP +- +.SH OVERVIEW +.PP +overview of punk::trie +.SS CONCEPTS +.PP +- +.SS DEPENDENCIES +.PP +packages used by punk::trie +.IP \(bu +\fBTcl 8\&.6\fR +.PP +.SH API +.SS "NAMESPACE PUNK::TRIE" +.PP +Core API functions for punk::trie +.IP [1] +CLASS \fBtrieclass\fR +.RS +.TP +class::trieclass \fBmatches\fR \fIt\fR \fIwhat\fR +.sp +search for longest prefix, return matching prefix, element and suffix +.RE +.PP +.SS "NAMESPACE PUNK::TRIE::LIB" +.PP +Secondary functions that are part of the API +.PP +.SH INTERNAL +tcl::namespace::eval punk::trie::system { +.SS "NAMESPACE PUNK::TRIE::SYSTEM" +.PP +Internal functions that are not part of the API +.SH KEYWORDS +datastructure, module, trie +.SH COPYRIGHT +.nf +Copyright (c) 2010 + +.fi diff --git a/src/embedded/man/files/punk/_module_uc-0.1.0.tm.n b/src/embedded/man/files/punk/_module_uc-0.1.0.tm.n index 1e3aa6af..e0df63db 100644 --- a/src/embedded/man/files/punk/_module_uc-0.1.0.tm.n +++ b/src/embedded/man/files/punk/_module_uc-0.1.0.tm.n @@ -2,7 +2,7 @@ '\" Generated from file '_module_uc-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2024 '\" -.TH "shellspy_module_punk::uc" 0 0\&.1\&.0 doc "-" +.TH "punkshell_module_punk::uc" 0 0\&.1\&.0 doc "-" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" @@ -272,7 +272,7 @@ Database Class: \\fB\\$3\\fR .. .BS .SH NAME -shellspy_module_punk::uc \- Module API +punkshell_module_punk::uc \- Module API .SH SYNOPSIS package require \fBpunk::uc \fR .sp @@ -310,7 +310,7 @@ Secondary functions that are part of the API .PP Internal functions that are not part of the API .SH KEYWORDS -module +module, unicode, unofficial, wcswidth .SH COPYRIGHT .nf Copyright (c) 2024 diff --git a/src/embedded/man/files/punk/_module_winlnk-0.1.0.tm.n b/src/embedded/man/files/punk/_module_winlnk-0.1.0.tm.n new file mode 100644 index 00000000..9d10b701 --- /dev/null +++ b/src/embedded/man/files/punk/_module_winlnk-0.1.0.tm.n @@ -0,0 +1,343 @@ +'\" +'\" Generated from file '_module_winlnk-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' +'\" Copyright (c) 2024 +'\" +.TH "punkshell_module_punk::winlnk" 0 0\&.1\&.0 doc "punk::winlnk" +.\" The -*- nroff -*- definitions below are for supplemental macros used +.\" in Tcl/Tk manual entries. +.\" +.\" .AP type name in/out ?indent? +.\" Start paragraph describing an argument to a library procedure. +.\" type is type of argument (int, etc.), in/out is either "in", "out", +.\" or "in/out" to describe whether procedure reads or modifies arg, +.\" and indent is equivalent to second arg of .IP (shouldn't ever be +.\" needed; use .AS below instead) +.\" +.\" .AS ?type? ?name? +.\" Give maximum sizes of arguments for setting tab stops. Type and +.\" name are examples of largest possible arguments that will be passed +.\" to .AP later. If args are omitted, default tab stops are used. +.\" +.\" .BS +.\" Start box enclosure. From here until next .BE, everything will be +.\" enclosed in one large box. +.\" +.\" .BE +.\" End of box enclosure. +.\" +.\" .CS +.\" Begin code excerpt. +.\" +.\" .CE +.\" End code excerpt. +.\" +.\" .VS ?version? ?br? +.\" Begin vertical sidebar, for use in marking newly-changed parts +.\" of man pages. The first argument is ignored and used for recording +.\" the version when the .VS was added, so that the sidebars can be +.\" found and removed when they reach a certain age. If another argument +.\" is present, then a line break is forced before starting the sidebar. +.\" +.\" .VE +.\" End of vertical sidebar. +.\" +.\" .DS +.\" Begin an indented unfilled display. +.\" +.\" .DE +.\" End of indented unfilled display. +.\" +.\" .SO ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three columns separated by tabs. +.\" +.\" .SE +.\" End of list of standard options for a Tk widget. +.\" +.\" .OP cmdName dbName dbClass +.\" Start of description of a specific option. cmdName gives the +.\" option's name as specified in the class command, dbName gives +.\" the option's name in the option database, and dbClass gives +.\" the option's class in the option database. +.\" +.\" .UL arg1 arg2 +.\" Print arg1 underlined, then print arg2 normally. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. +.if t .wh -1.3i ^B +.nr ^l \n(.l +.ad b +.\" # Start an argument description +.de AP +.ie !"\\$4"" .TP \\$4 +.el \{\ +. ie !"\\$2"" .TP \\n()Cu +. el .TP 15 +.\} +.ta \\n()Au \\n()Bu +.ie !"\\$3"" \{\ +\&\\$1 \\fI\\$2\\fP (\\$3) +.\".b +.\} +.el \{\ +.br +.ie !"\\$2"" \{\ +\&\\$1 \\fI\\$2\\fP +.\} +.el \{\ +\&\\fI\\$1\\fP +.\} +.\} +.. +.\" # define tabbing values for .AP +.de AS +.nr )A 10n +.if !"\\$1"" .nr )A \\w'\\$1'u+3n +.nr )B \\n()Au+15n +.\" +.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n +.nr )C \\n()Bu+\\w'(in/out)'u+2n +.. +.AS Tcl_Interp Tcl_CreateInterp in/out +.\" # BS - start boxed text +.\" # ^y = starting y location +.\" # ^b = 1 +.de BS +.br +.mk ^y +.nr ^b 1u +.if n .nf +.if n .ti 0 +.if n \l'\\n(.lu\(ul' +.if n .fi +.. +.\" # BE - end boxed text (draw box now) +.de BE +.nf +.ti 0 +.mk ^t +.ie n \l'\\n(^lu\(ul' +.el \{\ +.\" Draw four-sided box normally, but don't draw top of +.\" box if the box started on an earlier page. +.ie !\\n(^b-1 \{\ +\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' +.\} +.el \}\ +\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' +.\} +.\} +.fi +.br +.nr ^b 0 +.. +.\" # VS - start vertical sidebar +.\" # ^Y = starting y location +.\" # ^v = 1 (for troff; for nroff this doesn't matter) +.de VS +.if !"\\$2"" .br +.mk ^Y +.ie n 'mc \s12\(br\s0 +.el .nr ^v 1u +.. +.\" # VE - end of vertical sidebar +.de VE +.ie n 'mc +.el \{\ +.ev 2 +.nf +.ti 0 +.mk ^t +\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' +.sp -1 +.fi +.ev +.\} +.nr ^v 0 +.. +.\" # Special macro to handle page bottom: finish off current +.\" # box/sidebar if in box/sidebar mode, then invoked standard +.\" # page bottom macro. +.de ^B +.ev 2 +'ti 0 +'nf +.mk ^t +.if \\n(^b \{\ +.\" Draw three-sided box if this is the box's first page, +.\" draw two sides but no top otherwise. +.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c +.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c +.\} +.if \\n(^v \{\ +.nr ^x \\n(^tu+1v-\\n(^Yu +\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c +.\} +.bp +'fi +.ev +.if \\n(^b \{\ +.mk ^y +.nr ^b 2 +.\} +.if \\n(^v \{\ +.mk ^Y +.\} +.. +.\" # DS - begin display +.de DS +.RS +.nf +.sp +.. +.\" # DE - end display +.de DE +.fi +.RE +.sp +.. +.\" # SO - start of list of standard options +.de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR +.SH "STANDARD OPTIONS" +.LP +.nf +.ta 5.5c 11c +.ft B +.. +.\" # SE - end of list of standard options +.de SE +.fi +.ft R +.LP +See the \\*(So manual entry for details on the standard options. +.. +.\" # OP - start of full description for a single option +.de OP +.LP +.nf +.ta 4c +Command-Line Name: \\fB\\$1\\fR +Database Name: \\fB\\$2\\fR +Database Class: \\fB\\$3\\fR +.fi +.IP +.. +.\" # CS - begin code excerpt +.de CS +.RS +.nf +.ta .25i .5i .75i 1i +.. +.\" # CE - end code excerpt +.de CE +.fi +.RE +.. +.\" # UL - underline word +.de UL +\\$1\l'|0\(ul'\\$2 +.. +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. +.BS +.SH NAME +punkshell_module_punk::winlnk \- windows shortcut \&.lnk library +.SH SYNOPSIS +package require \fBpunk::winlnk \fR +.sp +\fBfile_check_header\fR \fIpath\fR +.sp +\fBfile_get_info\fR \fIpath\fR +.sp +.BE +.SH DESCRIPTION +.PP +Tools for reading windows shortcuts (\&.lnk files) on any platform +.SH OVERVIEW +.PP +overview of punk::winlnk +.SS CONCEPTS +.PP +Windows shortcuts are a binary format file with a \&.lnk extension +.PP +Shell Link (\&.LNK) Binary File Format is documented in [MS_SHLLINK]\&.pdf published by Microsoft\&. +.PP +Revision 8\&.0 published 2024-04-23 +.SS DEPENDENCIES +.PP +packages used by punk::winlnk +.IP \(bu +\fBTcl 8\&.6\fR +.PP +.SH API +.SS "NAMESPACE PUNK::WINLNK::CLASS" +.PP +class definitions +if { eq ""} { +.PP +} +} +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +.SS "NAMESPACE PUNK::WINLNK" +.PP +Core API functions for punk::winlnk +.TP +\fBfile_check_header\fR \fIpath\fR +.sp +Return 0|1 +.sp +Determines if the \&.lnk file specified in path has a valid header for a windows shortcut +.TP +\fBfile_get_info\fR \fIpath\fR +.sp +Return a dict of info obtained by parsing the binary data in a windows \&.lnk file +.sp +If the \&.lnk header check fails, then the \&.lnk file probably isn't really a shortcut file and the dictionary will contain an 'error' key +.PP +.SS "NAMESPACE PUNK::WINLNK::LIB" +.PP +Secondary functions that are part of the API +.PP +.SH INTERNAL +tcl::namespace::eval punk::winlnk::system { +.SS "NAMESPACE PUNK::WINLNK::SYSTEM" +.PP +Internal functions that are not part of the API +.SH KEYWORDS +crossplatform, lnk, module, parse, shortcut, windows +.SH COPYRIGHT +.nf +Copyright (c) 2024 + +.fi diff --git a/src/embedded/man/files/_module_overtype-1.6.3.tm.n b/src/embedded/man/files/punk/_module_zip-0.1.1.tm.n similarity index 66% rename from src/embedded/man/files/_module_overtype-1.6.3.tm.n rename to src/embedded/man/files/punk/_module_zip-0.1.1.tm.n index 46fb1efc..1271672e 100644 --- a/src/embedded/man/files/_module_overtype-1.6.3.tm.n +++ b/src/embedded/man/files/punk/_module_zip-0.1.1.tm.n @@ -1,8 +1,8 @@ '\" -'\" Generated from file '_module_overtype-1\&.6\&.3\&.tm\&.man' by tcllib/doctools with format 'nroff' +'\" Generated from file '_module_zip-0\&.1\&.1\&.tm\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2024 '\" -.TH "overtype_module_overtype" 0 1\&.6\&.3 doc "overtype text layout" +.TH "punkshell_module_punk::zip" 0 0\&.1\&.1 doc "-" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" @@ -272,13 +272,17 @@ Database Class: \\fB\\$3\\fR .. .BS .SH NAME -overtype_module_overtype \- overtype text layout - ansi aware +punkshell_module_punk::zip \- Module API .SH SYNOPSIS -package require \fBovertype \fR +package require \fBpunk::zip \fR .sp -\fBovertype::renderspace\fR \fIargs\fR +\fBTimet_to_dos\fR \fItime_t\fR .sp -\fBovertype::renderline\fR \fIargs\fR +\fBwalk\fR \fI?options?\fR \fIbase\fR +.sp +\fBAddentry\fR \fIzipchan\fR \fIbase\fR \fIpath\fR \fI?comment?\fR +.sp +\fBmkzip\fR ?\fB-offsettype\fR \fIoffsettype\fR? ?\fB-return\fR \fIreturntype\fR? ?\fB-zipkit\fR \fI0|1\fR? ?\fB-runtime\fR \fIpreamble_filename\fR? ?\fB-comment\fR \fIzipfilecomment\fR? ?\fB-directory\fR \fIdir_to_zip\fR? ?\fB-base\fR \fIarchive_root\fR? ?\fB-exclude\fR \fIgloblist\fR? \fIzipfilename\fR \fI?glob\&.\&.\&.?\fR .sp .BE .SH DESCRIPTION @@ -286,67 +290,75 @@ package require \fBovertype \fR - .SH OVERVIEW .PP -overview of overtype +overview of punk::zip .SS CONCEPTS .PP - .SS DEPENDENCIES .PP -packages used by overtype +packages used by punk::zip .IP \(bu \fBTcl 8\&.6\fR .IP \(bu -\fBtextutil\fR -.IP \(bu -\fBpunk::ansi\fR -.sp -- required to detect, split, strip and calculate lengths of text possibly containing ansi codes -.IP \(bu -\fBpunk::char\fR -.sp -- box drawing - and also unicode character width determination for proper layout of text with double-column-width chars +\fBpunk::args\fR .PP .SH API -.SS "NAMESPACE OVERTYPE" +.SS "NAMESPACE PUNK::ZIP" .PP -Core API functions for overtype +Core API functions for punk::zip .TP -\fBovertype::renderspace\fR \fIargs\fR +\fBTimet_to_dos\fR \fItime_t\fR .sp -usage: ?-transparent [0|1]? ?-overflow [1|0]? ?-ellipsis [1|0]? ?-ellipsistext \&.\&.\&.? undertext overtext +convert a unix timestamp into a DOS timestamp for ZIP times\&. +.CS + + + DOS timestamps are 32 bits split into bit regions as follows: + 24 16 8 0 + +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ + |Y|Y|Y|Y|Y|Y|Y|m| |m|m|m|d|d|d|d|d| |h|h|h|h|h|m|m|m| |m|m|m|s|s|s|s|s| + +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ + +.CE .TP -\fBovertype::renderline\fR \fIargs\fR -.sp -renderline is the core engine for overtype string processing (frames & textblocks), and the raw mode commandline repl for the Tcl Punk Shell +\fBwalk\fR \fI?options?\fR \fIbase\fR .sp -It is also a central part of an ansi (micro) virtual terminal-emulator of sorts +Walk a directory tree rooted at base .sp -This system does a half decent job at rendering 90's ANSI art to manipulable colour text blocks that can be joined & framed for layout display within a unix or windows terminal +the -excludes list can be a set of glob expressions to match against files and avoid .sp -Renderline helps maintain ANSI text styling reset/replay codes so that the styling of one block doesn't affect another\&. -.sp -Calling on the punk::ansi library - it can coalesce codes to keep the size down\&. -.sp -It is a giant mess of doing exactly what common wisdom says not to do\&.\&.\&. lots at once\&. -.sp -renderline is part of the Unicode and ANSI aware Overtype system which 'renders' a block of text onto a static underlay +e\&.g +.CS + + + punk::zip::walk -exclude {CVS/* *~\&.#*} library + +.CE +.TP +\fBAddentry\fR \fIzipchan\fR \fIbase\fR \fIpath\fR \fI?comment?\fR .sp -The underlay is generally expected to be an ordered set of lines or a rectangular text block analogous to a terminal screen - but it can also be ragged in line length, or just blank\&. +Add a single file to a zip archive .sp -The overlay couuld be similar - in which case it may often be used to overwrite a column or section of the underlay\&. +The zipchan channel should already be open and binary\&. .sp -The overlay could however be a sequence of ANSI-laden text that jumps all over the place\&. +You can provide a -comment for the file\&. .sp -renderline itself only deals with a single line - or sometimes a single character\&. It is generally called from a loop that does further terminal-like or textblock processing\&. +The return value is the central directory record that will need to be used when finalizing the zip archive\&. +.TP +\fBmkzip\fR ?\fB-offsettype\fR \fIoffsettype\fR? ?\fB-return\fR \fIreturntype\fR? ?\fB-zipkit\fR \fI0|1\fR? ?\fB-runtime\fR \fIpreamble_filename\fR? ?\fB-comment\fR \fIzipfilecomment\fR? ?\fB-directory\fR \fIdir_to_zip\fR? ?\fB-base\fR \fIarchive_root\fR? ?\fB-exclude\fR \fIgloblist\fR? \fIzipfilename\fR \fI?glob\&.\&.\&.?\fR .sp -By suppyling the -info 1 option - it can return various fields indicating the state of the render\&. +Create a zip archive in 'zipfilename' .sp -The main 3 are the result, overflow_right, and unapplied\&. +If a file already exists, an error will be raised\&. .sp -Renderline handles cursor movements from either keystrokes or ANSI sequences but for a full system the aforementioned loop will need to be in place to manage the set of lines under manipulation\&. +Call 'punk::zip::mkzip' with no arguments for usage display\&. +.PP +.SS "NAMESPACE PUNK::ZIP::LIB" +.PP +Secondary functions that are part of the API .PP .SH KEYWORDS -ansi, module, text +fileformat, module, zip .SH COPYRIGHT .nf Copyright (c) 2024 diff --git a/src/embedded/man/files/_module_overtype-1.6.4.tm.n b/src/embedded/man/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.n similarity index 66% rename from src/embedded/man/files/_module_overtype-1.6.4.tm.n rename to src/embedded/man/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.n index 26c43970..4a9137a7 100644 --- a/src/embedded/man/files/_module_overtype-1.6.4.tm.n +++ b/src/embedded/man/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.n @@ -1,8 +1,8 @@ '\" -'\" Generated from file '_module_overtype-1\&.6\&.4\&.tm\&.man' by tcllib/doctools with format 'nroff' +'\" Generated from file '_module_scriptwrap-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2024 '\" -.TH "overtype_module_overtype" 0 1\&.6\&.4 doc "overtype text layout" +.TH "punkshell_module_scriptwrap" 0 0\&.1\&.0 doc "scriptwrap tool" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" @@ -272,13 +272,11 @@ Database Class: \\fB\\$3\\fR .. .BS .SH NAME -overtype_module_overtype \- overtype text layout - ansi aware +punkshell_module_scriptwrap \- scriptwrap polyglot tool .SH SYNOPSIS -package require \fBovertype \fR +package require \fBpunk::mix::commandset::scriptwrap \fR .sp -\fBovertype::renderspace\fR \fIargs\fR -.sp -\fBovertype::renderline\fR \fIargs\fR +\fBget_wrapper_folders\fR \fIargs\fR .sp .BE .SH DESCRIPTION @@ -286,67 +284,52 @@ package require \fBovertype \fR - .SH OVERVIEW .PP -overview of overtype +overview of scriptwrap .SS CONCEPTS .PP - .SS DEPENDENCIES .PP -packages used by overtype +packages used by poshinfo .IP \(bu \fBTcl 8\&.6\fR .IP \(bu -\fBtextutil\fR +\fBpunk::lib\fR .IP \(bu -\fBpunk::ansi\fR -.sp -- required to detect, split, strip and calculate lengths of text possibly containing ansi codes +\fBpunk::args\fR .IP \(bu -\fBpunk::char\fR -.sp -- box drawing - and also unicode character width determination for proper layout of text with double-column-width chars +\fBpunk::mix\fR +.IP \(bu +\fBpunk::base\fR +.IP \(bu +\fBpunk::fileline\fR .PP .SH API -.SS "NAMESPACE OVERTYPE" +.SS "NAMESPACE PUNK::MIX::COMMANDSET::SCRIPTWRAP" .PP -Core API functions for overtype -.TP -\fBovertype::renderspace\fR \fIargs\fR -.sp -usage: ?-transparent [0|1]? ?-overflow [1|0]? ?-ellipsis [1|0]? ?-ellipsistext \&.\&.\&.? undertext overtext +Core API functions for punk::mix::commandset::scriptwrap +.PP +.SS "NAMESPACE PUNK::MIX::COMMANDSET::SCRIPTWRAP::LIB" +.PP +Library API functions for punk::mix::commandset::scriptwrap .TP -\fBovertype::renderline\fR \fIargs\fR -.sp -renderline is the core engine for overtype string processing (frames & textblocks), and the raw mode commandline repl for the Tcl Punk Shell -.sp -It is also a central part of an ansi (micro) virtual terminal-emulator of sorts -.sp -This system does a half decent job at rendering 90's ANSI art to manipulable colour text blocks that can be joined & framed for layout display within a unix or windows terminal -.sp -Renderline helps maintain ANSI text styling reset/replay codes so that the styling of one block doesn't affect another\&. +\fBget_wrapper_folders\fR \fIargs\fR .sp -Calling on the punk::ansi library - it can coalesce codes to keep the size down\&. +Return list of dicts representing wrapper folders in the project\&. keys: basefolder sourceinfo .sp -It is a giant mess of doing exactly what common wisdom says not to do\&.\&.\&. lots at once\&. -.sp -renderline is part of the Unicode and ANSI aware Overtype system which 'renders' a block of text onto a static underlay -.sp -The underlay is generally expected to be an ordered set of lines or a rectangular text block analogous to a terminal screen - but it can also be ragged in line length, or just blank\&. -.sp -The overlay couuld be similar - in which case it may often be used to overwrite a column or section of the underlay\&. -.sp -The overlay could however be a sequence of ANSI-laden text that jumps all over the place\&. -.sp -renderline itself only deals with a single line - or sometimes a single character\&. It is generally called from a loop that does further terminal-like or textblock processing\&. -.sp -By suppyling the -info 1 option - it can return various fields indicating the state of the render\&. -.sp -The main 3 are the result, overflow_right, and unapplied\&. -.sp -Renderline handles cursor movements from either keystrokes or ANSI sequences but for a full system the aforementioned loop will need to be in place to manage the set of lines under manipulation\&. +Arguments: +.RS +.TP +string \fIargs\fR +name-value pairs -scriptpath +.RE +.PP +.SS "NAMESPACE PUNK::MIX::COMMANDSET::SCRIPTWRAP::BATCHLIB" +.PP +Utility funcions for processing windows \&.bat files .PP .SH KEYWORDS -ansi, module, text +commandset, launcher, module, scriptwrap .SH COPYRIGHT .nf Copyright (c) 2024 diff --git a/src/embedded/man/files/punk/nav/_module_fs-0.1.0.tm.n b/src/embedded/man/files/punk/nav/_module_fs-0.1.0.tm.n index e92eec87..9a9fcc39 100644 --- a/src/embedded/man/files/punk/nav/_module_fs-0.1.0.tm.n +++ b/src/embedded/man/files/punk/nav/_module_fs-0.1.0.tm.n @@ -2,7 +2,7 @@ '\" Generated from file '_module_fs-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2024 '\" -.TH "shellspy_module_punk::nav::fs" 0 0\&.1\&.0 doc "-" +.TH "shellspy_module_punk::nav::fs" 0 0\&.1\&.0 doc "fs nav" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" @@ -272,7 +272,7 @@ Database Class: \\fB\\$3\\fR .. .BS .SH NAME -shellspy_module_punk::nav::fs \- Module API +shellspy_module_punk::nav::fs \- punk::nav::fs console filesystem navigation .SH SYNOPSIS package require \fBpunk::nav::fs \fR .sp @@ -324,7 +324,7 @@ Secondary functions that are part of the API .PP Internal functions that are not part of the API .SH KEYWORDS -module +filesystem, module, terminal .SH COPYRIGHT .nf Copyright (c) 2024 diff --git a/src/embedded/man/files/punk/repl/_module_codethread-0.1.0.tm.n b/src/embedded/man/files/punk/repl/_module_codethread-0.1.0.tm.n index 9742abb0..edd58268 100644 --- a/src/embedded/man/files/punk/repl/_module_codethread-0.1.0.tm.n +++ b/src/embedded/man/files/punk/repl/_module_codethread-0.1.0.tm.n @@ -2,7 +2,7 @@ '\" Generated from file '_module_codethread-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2024 '\" -.TH "shellspy_module_punk::repl::codethread" 0 0\&.1\&.0 doc "-" +.TH "shellspy_module_punk::repl::codethread" 0 0\&.1\&.0 doc "codethread for repl - root interpreter" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" @@ -272,14 +272,14 @@ Database Class: \\fB\\$3\\fR .. .BS .SH NAME -shellspy_module_punk::repl::codethread \- Module API +shellspy_module_punk::repl::codethread \- Module repl codethread .SH SYNOPSIS package require \fBpunk::repl::codethread \fR .sp .BE .SH DESCRIPTION .PP -- +This is part of the infrastructure required for the punk::repl to operate .SH OVERVIEW .PP overview of punk::repl::codethread @@ -314,7 +314,7 @@ Secondary functions that are part of the API .PP Internal functions that are not part of the API .SH KEYWORDS -module +module, repl .SH COPYRIGHT .nf Copyright (c) 2024 diff --git a/src/embedded/man/index.n b/src/embedded/man/index.n index 59236026..a3822414 100644 --- a/src/embedded/man/index.n +++ b/src/embedded/man/index.n @@ -278,20 +278,29 @@ BOM \fBfiles/punk/_module_fileline-0\&.1\&.0\&.tm\&.n\fR punkshell_module_punk::fileline .RE -ansi +POSH .RS .TP -\fBfiles/_module_overtype-1\&.6\&.4\&.tm\&.n\fR -overtype_module_overtype +\fBfiles/_module_poshinfo-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_poshinfo +.RE +alias +.RS .TP -\fBfiles/_module_overtype-1\&.6\&.3\&.tm\&.n\fR -overtype_module_overtype +\fBfiles/punk/_module_aliascore-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::aliascore +.RE +ansi +.RS .TP \fBfiles/_module_overtype-1\&.6\&.5\&.tm\&.n\fR overtype_module_overtype .TP \fBfiles/punk/_module_ansi-0\&.1\&.1\&.tm\&.n\fR punkshell_module_punk::ansi +.TP +\fBfiles/_module_textblock-0\&.1\&.2\&.tm\&.n\fR +punkshell_module_textblock .RE args .RS @@ -309,13 +318,13 @@ assert .RS .TP \fBfiles/punk/_module_assertion-0\&.1\&.0\&.tm\&.n\fR -shellspy_module_punk::assertion +punkshell_module_punk::assertion .RE assertion .RS .TP \fBfiles/punk/_module_assertion-0\&.1\&.0\&.tm\&.n\fR -shellspy_module_punk::assertion +punkshell_module_punk::assertion .RE capability .RS @@ -323,30 +332,84 @@ capability \fBfiles/punk/_module_cap-0\&.1\&.0\&.tm\&.n\fR punkshell_module_punk::cap .RE +cesu +.RS +.TP +\fBfiles/punk/_module_cesu-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::cesu +.RE changelog .RS .TP \fBfiles/project_changes\&.n\fR punkshell__project_changes .RE +colour +.RS +.TP +\fBfiles/_module_textblock-0\&.1\&.2\&.tm\&.n\fR +punkshell_module_textblock +.RE +commandset +.RS +.TP +\fBfiles/punk/mix/commandset/_module_scriptwrap-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_scriptwrap +.RE +compatibility +.RS +.TP +\fBfiles/punk/_module_cesu-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::cesu +.RE +configuration +.RS +.TP +\fBfiles/_module_tomlish-1\&.1\&.1\&.tm\&.n\fR +tomlish_module_tomlish +.RE console .RS .TP +\fBfiles/punk/_module_basictelnet-0\&.1\&.0\&.tm\&.n\fR +punkshell::basictelnet +.TP +\fBfiles/_module_poshinfo-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_poshinfo +.TP \fBfiles/punk/_module_ansi-0\&.1\&.1\&.tm\&.n\fR punkshell_module_punk::ansi .TP \fBfiles/punk/_module_console-0\&.1\&.1\&.tm\&.n\fR punkshell_module_punk::console +.TP +\fBfiles/_module_textblock-0\&.1\&.2\&.tm\&.n\fR +punkshell_module_textblock +.RE +crossplatform +.RS +.TP +\fBfiles/punk/_module_winlnk-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::winlnk +.RE +datastructure +.RS +.TP +\fBfiles/punk/_module_trie-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::trie .RE debug .RS .TP \fBfiles/punk/_module_assertion-0\&.1\&.0\&.tm\&.n\fR -shellspy_module_punk::assertion +punkshell_module_punk::assertion .RE encoding .RS .TP +\fBfiles/punk/_module_cesu-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::cesu +.TP \fBfiles/punk/_module_fileline-0\&.1\&.0\&.tm\&.n\fR punkshell_module_punk::fileline .RE @@ -362,29 +425,77 @@ punkshell_module_punk::encmime experimental .RS .TP +\fBfiles/punk/_module_cesu-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::cesu +.TP \fBfiles/punk/_module_flib-0\&.1\&.0\&.tm\&.n\fR punkshell_module_punk::flib .RE +fake +.RS +.TP +\fBfiles/_module_fauxlink-0\&.1\&.1\&.tm\&.n\fR +fauxlink_module_fauxlink +.RE +faux +.RS +.TP +\fBfiles/_module_fauxlink-0\&.1\&.1\&.tm\&.n\fR +fauxlink_module_fauxlink +.RE file .RS .TP \fBfiles/punk/_module_fileline-0\&.1\&.0\&.tm\&.n\fR punkshell_module_punk::fileline .RE +fileformat +.RS +.TP +\fBfiles/punk/_module_zip-0\&.1\&.1\&.tm\&.n\fR +punkshell_module_punk::zip +.RE filesystem .RS .TP +\fBfiles/punk/_module_island-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::island +.TP \fBfiles/punk/_module_path-0\&.1\&.0\&.tm\&.n\fR punkshell_module_punk::path .TP -\fBfiles/punk/_module_island-0\&.1\&.0\&.tm\&.n\fR -shellspy_module_punk::island +\fBfiles/punk/nav/_module_fs-0\&.1\&.0\&.tm\&.n\fR +shellspy_module_punk::nav::fs +.RE +frame +.RS +.TP +\fBfiles/_module_textblock-0\&.1\&.2\&.tm\&.n\fR +punkshell_module_textblock +.RE +http +.RS +.TP +\fBfiles/punk/_module_rest-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::rest .RE interp .RS .TP \fBfiles/punk/_module_island-0\&.1\&.0\&.tm\&.n\fR -shellspy_module_punk::island +punkshell_module_punk::island +.RE +launcher +.RS +.TP +\fBfiles/punk/mix/commandset/_module_scriptwrap-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_scriptwrap +.RE +layout +.RS +.TP +\fBfiles/_module_textblock-0\&.1\&.2\&.tm\&.n\fR +punkshell_module_textblock .RE lib .RS @@ -395,20 +506,32 @@ punkshell_module_punk::lib \fBfiles/_module_textblock-0\&.1\&.1\&.tm\&.n\fR punkshell_module_textblock .RE +lnk +.RS +.TP +\fBfiles/punk/_module_winlnk-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::winlnk +.RE module .RS .TP -\fBfiles/_module_modpod-0\&.1\&.0\&.tm\&.n\fR +\fBfiles/_module_modpod-0\&.1\&.2\&.tm\&.n\fR modpod_module_modpod .TP -\fBfiles/_module_overtype-1\&.6\&.4\&.tm\&.n\fR +\fBfiles/_module_overtype-1\&.6\&.5\&.tm\&.n\fR overtype_module_overtype .TP -\fBfiles/_module_overtype-1\&.6\&.3\&.tm\&.n\fR -overtype_module_overtype +\fBfiles/punk/_module_basictelnet-0\&.1\&.0\&.tm\&.n\fR +punkshell::basictelnet .TP -\fBfiles/_module_overtype-1\&.6\&.5\&.tm\&.n\fR -overtype_module_overtype +\fBfiles/_module_argparsingtest-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_argparsingtest +.TP +\fBfiles/_module_poshinfo-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_poshinfo +.TP +\fBfiles/punk/_module_aliascore-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::aliascore .TP \fBfiles/punk/_module_ansi-0\&.1\&.1\&.tm\&.n\fR punkshell_module_punk::ansi @@ -416,9 +539,18 @@ punkshell_module_punk::ansi \fBfiles/punk/_module_args-0\&.1\&.0\&.tm\&.n\fR punkshell_module_punk::args .TP +\fBfiles/punk/_module_assertion-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::assertion +.TP +\fBfiles/punk/_module_blockletter-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::blockletter +.TP \fBfiles/punk/_module_cap-0\&.1\&.0\&.tm\&.n\fR punkshell_module_punk::cap .TP +\fBfiles/punk/_module_cesu-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::cesu +.TP \fBfiles/punk/_module_char-0\&.1\&.0\&.tm\&.n\fR punkshell_module_punk::char .TP @@ -428,63 +560,72 @@ punkshell_module_punk::console \fBfiles/punk/_module_encmime-0\&.1\&.0\&.tm\&.n\fR punkshell_module_punk::encmime .TP +\fBfiles/punk/_module_experiment-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::experiment +.TP \fBfiles/punk/_module_fileline-0\&.1\&.0\&.tm\&.n\fR punkshell_module_punk::fileline .TP \fBfiles/punk/_module_flib-0\&.1\&.0\&.tm\&.n\fR punkshell_module_punk::flib .TP +\fBfiles/punk/_module_island-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::island +.TP \fBfiles/punk/_module_lib-0\&.1\&.1\&.tm\&.n\fR punkshell_module_punk::lib .TP +\fBfiles/punk/_module_packagepreference-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::packagepreference +.TP \fBfiles/punk/_module_path-0\&.1\&.0\&.tm\&.n\fR punkshell_module_punk::path .TP -\fBfiles/_module_textblock-0\&.1\&.1\&.tm\&.n\fR -punkshell_module_textblock +\fBfiles/punk/_module_rest-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::rest .TP -\fBfiles/_module_argparsingtest-0\&.1\&.0\&.tm\&.n\fR -shellspy_module_argparsingtest +\fBfiles/punk/_module_sshrun-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::sshrun .TP -\fBfiles/_module_poshinfo-0\&.1\&.0\&.tm\&.n\fR -shellspy_module_poshinfo +\fBfiles/punk/_module_trie-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::trie .TP -\fBfiles/punk/_module_aliascore-0\&.1\&.0\&.tm\&.n\fR -shellspy_module_punk::aliascore +\fBfiles/punk/_module_uc-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::uc .TP -\fBfiles/punk/_module_assertion-0\&.1\&.0\&.tm\&.n\fR -shellspy_module_punk::assertion +\fBfiles/punk/_module_winlnk-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::winlnk .TP -\fBfiles/punk/_module_basictelnet-0\&.1\&.0\&.tm\&.n\fR -shellspy_module_punk::basictelnet +\fBfiles/punk/_module_zip-0\&.1\&.1\&.tm\&.n\fR +punkshell_module_punk::zip .TP -\fBfiles/punk/_module_experiment-0\&.1\&.0\&.tm\&.n\fR -shellspy_module_punk::experiment +\fBfiles/punk/mix/commandset/_module_scriptwrap-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_scriptwrap .TP -\fBfiles/punk/_module_island-0\&.1\&.0\&.tm\&.n\fR -shellspy_module_punk::island +\fBfiles/_module_textblock-0\&.1\&.1\&.tm\&.n\fR +punkshell_module_textblock +.TP +\fBfiles/_module_textblock-0\&.1\&.2\&.tm\&.n\fR +punkshell_module_textblock .TP \fBfiles/punk/nav/_module_fs-0\&.1\&.0\&.tm\&.n\fR shellspy_module_punk::nav::fs .TP -\fBfiles/punk/_module_packagepreference-0\&.1\&.0\&.tm\&.n\fR -shellspy_module_punk::packagepreference -.TP \fBfiles/punk/repl/_module_codethread-0\&.1\&.0\&.tm\&.n\fR shellspy_module_punk::repl::codethread .TP -\fBfiles/punk/_module_sshrun-0\&.1\&.0\&.tm\&.n\fR -shellspy_module_punk::sshrun -.TP -\fBfiles/punk/_module_uc-0\&.1\&.0\&.tm\&.n\fR -shellspy_module_punk::uc -.TP \fBfiles/punk/_module_zip-0\&.1\&.0\&.tm\&.n\fR shellspy_module_punk::zip .TP \fBfiles/_module_tomlish-1\&.1\&.1\&.tm\&.n\fR tomlish_module_tomlish .RE +package +.RS +.TP +\fBfiles/punk/_module_packagepreference-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::packagepreference +.RE parse .RS .TP @@ -493,6 +634,15 @@ punkshell_module_punk::args .TP \fBfiles/punk/_module_fileline-0\&.1\&.0\&.tm\&.n\fR punkshell_module_punk::fileline +.TP +\fBfiles/punk/_module_winlnk-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::winlnk +.RE +parsing +.RS +.TP +\fBfiles/_module_tomlish-1\&.1\&.1\&.tm\&.n\fR +tomlish_module_tomlish .RE path .RS @@ -512,6 +662,24 @@ proc \fBfiles/punk/_module_args-0\&.1\&.0\&.tm\&.n\fR punkshell_module_punk::args .RE +prompt +.RS +.TP +\fBfiles/_module_poshinfo-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_poshinfo +.RE +prompt theme +.RS +.TP +\fBfiles/_module_poshinfo-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_poshinfo +.RE +protocol +.RS +.TP +\fBfiles/punk/_module_basictelnet-0\&.1\&.0\&.tm\&.n\fR +punkshell::basictelnet +.RE punk .RS .TP @@ -535,6 +703,21 @@ punkshell__project_changes .TP \fBfiles/project_intro\&.n\fR punkshell__project_intro +.TP +\fBfiles/punk/repl/_module_codethread-0\&.1\&.0\&.tm\&.n\fR +shellspy_module_punk::repl::codethread +.RE +rest +.RS +.TP +\fBfiles/punk/_module_rest-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::rest +.RE +scriptwrap +.RS +.TP +\fBfiles/punk/mix/commandset/_module_scriptwrap-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_scriptwrap .RE shell .RS @@ -548,11 +731,20 @@ punkshell__project_changes \fBfiles/project_intro\&.n\fR punkshell__project_intro .RE +shortcut +.RS +.TP +\fBfiles/_module_fauxlink-0\&.1\&.1\&.tm\&.n\fR +fauxlink_module_fauxlink +.TP +\fBfiles/punk/_module_winlnk-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::winlnk +.RE ssh .RS .TP \fBfiles/punk/_module_sshrun-0\&.1\&.0\&.tm\&.n\fR -shellspy_module_punk::sshrun +punkshell_module_punk::sshrun .RE string .RS @@ -560,29 +752,92 @@ string \fBfiles/punk/_module_ansi-0\&.1\&.1\&.tm\&.n\fR punkshell_module_punk::ansi .RE +symlink +.RS +.TP +\fBfiles/_module_fauxlink-0\&.1\&.1\&.tm\&.n\fR +fauxlink_module_fauxlink +.RE +table +.RS +.TP +\fBfiles/_module_textblock-0\&.1\&.2\&.tm\&.n\fR +punkshell_module_textblock +.RE +telnet +.RS +.TP +\fBfiles/punk/_module_basictelnet-0\&.1\&.0\&.tm\&.n\fR +punkshell::basictelnet +.RE terminal .RS .TP +\fBfiles/punk/_module_basictelnet-0\&.1\&.0\&.tm\&.n\fR +punkshell::basictelnet +.TP +\fBfiles/_module_poshinfo-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_poshinfo +.TP \fBfiles/punk/_module_ansi-0\&.1\&.1\&.tm\&.n\fR punkshell_module_punk::ansi .TP \fBfiles/punk/_module_console-0\&.1\&.1\&.tm\&.n\fR punkshell_module_punk::console +.TP +\fBfiles/_module_textblock-0\&.1\&.2\&.tm\&.n\fR +punkshell_module_textblock +.TP +\fBfiles/punk/nav/_module_fs-0\&.1\&.0\&.tm\&.n\fR +shellspy_module_punk::nav::fs .RE text .RS .TP -\fBfiles/_module_overtype-1\&.6\&.4\&.tm\&.n\fR -overtype_module_overtype -.TP -\fBfiles/_module_overtype-1\&.6\&.3\&.tm\&.n\fR -overtype_module_overtype -.TP \fBfiles/_module_overtype-1\&.6\&.5\&.tm\&.n\fR overtype_module_overtype .TP \fBfiles/punk/_module_fileline-0\&.1\&.0\&.tm\&.n\fR punkshell_module_punk::fileline +.TP +\fBfiles/_module_textblock-0\&.1\&.2\&.tm\&.n\fR +punkshell_module_textblock +.RE +theme +.RS +.TP +\fBfiles/_module_poshinfo-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_poshinfo +.RE +toml +.RS +.TP +\fBfiles/_module_fauxlink-0\&.1\&.1\&.tm\&.n\fR +fauxlink_module_fauxlink +.TP +\fBfiles/_module_tomlish-1\&.1\&.1\&.tm\&.n\fR +tomlish_module_tomlish +.RE +trie +.RS +.TP +\fBfiles/punk/_module_trie-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::trie +.RE +unicode +.RS +.TP +\fBfiles/punk/_module_uc-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::uc +.RE +unofficial +.RS +.TP +\fBfiles/punk/_module_cesu-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::cesu +.TP +\fBfiles/punk/_module_uc-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::uc .RE utility .RS @@ -593,4 +848,22 @@ punkshell_module_punk::lib \fBfiles/_module_textblock-0\&.1\&.1\&.tm\&.n\fR punkshell_module_textblock .RE +wcswidth +.RS +.TP +\fBfiles/punk/_module_uc-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::uc +.RE +windows +.RS +.TP +\fBfiles/punk/_module_winlnk-0\&.1\&.0\&.tm\&.n\fR +punkshell_module_punk::winlnk +.RE +zip +.RS +.TP +\fBfiles/punk/_module_zip-0\&.1\&.1\&.tm\&.n\fR +punkshell_module_punk::zip +.RE .RE diff --git a/src/embedded/man/toc.n b/src/embedded/man/toc.n index dd2d319f..46819ef1 100644 --- a/src/embedded/man/toc.n +++ b/src/embedded/man/toc.n @@ -273,14 +273,11 @@ Database Class: \\fB\\$3\\fR doc .RS .TP -\fBmodpod_module_modpod\fR -\fIfiles/_module_modpod-0\&.1\&.0\&.tm\&.n\fR: Module API -.TP -\fBovertype_module_overtype\fR -\fIfiles/_module_overtype-1\&.6\&.4\&.tm\&.n\fR: overtype text layout - ansi aware +\fBfauxlink_module_fauxlink\fR +\fIfiles/_module_fauxlink-0\&.1\&.1\&.tm\&.n\fR: faux link application shortcuts .TP -\fBovertype_module_overtype\fR -\fIfiles/_module_overtype-1\&.6\&.3\&.tm\&.n\fR: overtype text layout - ansi aware +\fBmodpod_module_modpod\fR +\fIfiles/_module_modpod-0\&.1\&.2\&.tm\&.n\fR: Module API .TP \fBovertype_module_overtype\fR \fIfiles/_module_overtype-1\&.6\&.5\&.tm\&.n\fR: overtype text layout - ansi aware @@ -288,21 +285,42 @@ doc \fBpunkshell\fR \fIfiles/main\&.n\fR: punkshell - Core .TP +\fBpunkshell::basictelnet\fR +\fIfiles/punk/_module_basictelnet-0\&.1\&.0\&.tm\&.n\fR: basic telnet client - DKF/Wiki +.TP \fBpunkshell__project_changes\fR \fIfiles/project_changes\&.n\fR: punkshell Changes .TP \fBpunkshell__project_intro\fR \fIfiles/project_intro\&.n\fR: Introduction to punkshell .TP +\fBpunkshell_module_argparsingtest\fR +\fIfiles/_module_argparsingtest-0\&.1\&.0\&.tm\&.n\fR: Module API +.TP +\fBpunkshell_module_poshinfo\fR +\fIfiles/_module_poshinfo-0\&.1\&.0\&.tm\&.n\fR: poshinfo prompt theme tool +.TP +\fBpunkshell_module_punk::aliascore\fR +\fIfiles/punk/_module_aliascore-0\&.1\&.0\&.tm\&.n\fR: punkshell command aliases +.TP \fBpunkshell_module_punk::ansi\fR \fIfiles/punk/_module_ansi-0\&.1\&.1\&.tm\&.n\fR: Ansi string functions .TP \fBpunkshell_module_punk::args\fR \fIfiles/punk/_module_args-0\&.1\&.0\&.tm\&.n\fR: args parsing .TP +\fBpunkshell_module_punk::assertion\fR +\fIfiles/punk/_module_assertion-0\&.1\&.0\&.tm\&.n\fR: assertion alternative to control::assert +.TP +\fBpunkshell_module_punk::blockletter\fR +\fIfiles/punk/_module_blockletter-0\&.1\&.0\&.tm\&.n\fR: punk::blockletter frame-based large lettering test/logo +.TP \fBpunkshell_module_punk::cap\fR \fIfiles/punk/_module_cap-0\&.1\&.0\&.tm\&.n\fR: capability provider and handler plugin system .TP +\fBpunkshell_module_punk::cesu\fR +\fIfiles/punk/_module_cesu-0\&.1\&.0\&.tm\&.n\fR: CESU compatibility ehcoding scheme for utf-16: 8-Bit (CESU-8) ?? +.TP \fBpunkshell_module_punk::char\fR \fIfiles/punk/_module_char-0\&.1\&.0\&.tm\&.n\fR: character-set and unicode utilities .TP @@ -312,62 +330,65 @@ doc \fBpunkshell_module_punk::encmime\fR \fIfiles/punk/_module_encmime-0\&.1\&.0\&.tm\&.n\fR: mime encodings related subset of tcllib mime .TP +\fBpunkshell_module_punk::experiment\fR +\fIfiles/punk/_module_experiment-0\&.1\&.0\&.tm\&.n\fR: Module API +.TP \fBpunkshell_module_punk::fileline\fR \fIfiles/punk/_module_fileline-0\&.1\&.0\&.tm\&.n\fR: file line-handling utilities .TP \fBpunkshell_module_punk::flib\fR \fIfiles/punk/_module_flib-0\&.1\&.0\&.tm\&.n\fR: flib experimental .TP +\fBpunkshell_module_punk::island\fR +\fIfiles/punk/_module_island-0\&.1\&.0\&.tm\&.n\fR: filesystem islands for safe interps +.TP \fBpunkshell_module_punk::lib\fR \fIfiles/punk/_module_lib-0\&.1\&.1\&.tm\&.n\fR: punk general utility functions .TP \fBpunkshell_module_punk::mix::commandset::project\fR \fIfiles/punk/mix/commandset/_module_project-0\&.1\&.0\&.tm\&.n\fR: dec commandset - project .TP +\fBpunkshell_module_punk::packagepreference\fR +\fIfiles/punk/_module_packagepreference-0\&.1\&.0\&.tm\&.n\fR: punkshell package/module loading +.TP \fBpunkshell_module_punk::path\fR \fIfiles/punk/_module_path-0\&.1\&.0\&.tm\&.n\fR: Filesystem path utilities .TP -\fBpunkshell_module_textblock\fR -\fIfiles/_module_textblock-0\&.1\&.1\&.tm\&.n\fR: punk textblock functions +\fBpunkshell_module_punk::rest\fR +\fIfiles/punk/_module_rest-0\&.1\&.0\&.tm\&.n\fR: punk::rest .TP -\fBshellspy_module_argparsingtest\fR -\fIfiles/_module_argparsingtest-0\&.1\&.0\&.tm\&.n\fR: Module API +\fBpunkshell_module_punk::sshrun\fR +\fIfiles/punk/_module_sshrun-0\&.1\&.0\&.tm\&.n\fR: Tcl procedures to execute tcl scripts in remote hosts .TP -\fBshellspy_module_poshinfo\fR -\fIfiles/_module_poshinfo-0\&.1\&.0\&.tm\&.n\fR: Module API +\fBpunkshell_module_punk::trie\fR +\fIfiles/punk/_module_trie-0\&.1\&.0\&.tm\&.n\fR: punk::trie API .TP -\fBshellspy_module_punk::aliascore\fR -\fIfiles/punk/_module_aliascore-0\&.1\&.0\&.tm\&.n\fR: Module API +\fBpunkshell_module_punk::uc\fR +\fIfiles/punk/_module_uc-0\&.1\&.0\&.tm\&.n\fR: Module API .TP -\fBshellspy_module_punk::assertion\fR -\fIfiles/punk/_module_assertion-0\&.1\&.0\&.tm\&.n\fR: assertion alternative to control::assert +\fBpunkshell_module_punk::winlnk\fR +\fIfiles/punk/_module_winlnk-0\&.1\&.0\&.tm\&.n\fR: windows shortcut \&.lnk library .TP -\fBshellspy_module_punk::basictelnet\fR -\fIfiles/punk/_module_basictelnet-0\&.1\&.0\&.tm\&.n\fR: basic telnet client - DKF/Wiki +\fBpunkshell_module_punk::zip\fR +\fIfiles/punk/_module_zip-0\&.1\&.1\&.tm\&.n\fR: Module API .TP -\fBshellspy_module_punk::experiment\fR -\fIfiles/punk/_module_experiment-0\&.1\&.0\&.tm\&.n\fR: Module API +\fBpunkshell_module_scriptwrap\fR +\fIfiles/punk/mix/commandset/_module_scriptwrap-0\&.1\&.0\&.tm\&.n\fR: scriptwrap polyglot tool .TP -\fBshellspy_module_punk::island\fR -\fIfiles/punk/_module_island-0\&.1\&.0\&.tm\&.n\fR: filesystem islands for safe interps +\fBpunkshell_module_textblock\fR +\fIfiles/_module_textblock-0\&.1\&.1\&.tm\&.n\fR: punk textblock functions .TP -\fBshellspy_module_punk::nav::fs\fR -\fIfiles/punk/nav/_module_fs-0\&.1\&.0\&.tm\&.n\fR: Module API +\fBpunkshell_module_textblock\fR +\fIfiles/_module_textblock-0\&.1\&.2\&.tm\&.n\fR: punk textblock functions .TP -\fBshellspy_module_punk::packagepreference\fR -\fIfiles/punk/_module_packagepreference-0\&.1\&.0\&.tm\&.n\fR: Module API +\fBshellspy_module_punk::nav::fs\fR +\fIfiles/punk/nav/_module_fs-0\&.1\&.0\&.tm\&.n\fR: punk::nav::fs console filesystem navigation .TP \fBshellspy_module_punk::repl::codethread\fR -\fIfiles/punk/repl/_module_codethread-0\&.1\&.0\&.tm\&.n\fR: Module API -.TP -\fBshellspy_module_punk::sshrun\fR -\fIfiles/punk/_module_sshrun-0\&.1\&.0\&.tm\&.n\fR: Tcl procedures to execute tcl scripts in remote hosts -.TP -\fBshellspy_module_punk::uc\fR -\fIfiles/punk/_module_uc-0\&.1\&.0\&.tm\&.n\fR: Module API +\fIfiles/punk/repl/_module_codethread-0\&.1\&.0\&.tm\&.n\fR: Module repl codethread .TP \fBshellspy_module_punk::zip\fR \fIfiles/punk/_module_zip-0\&.1\&.0\&.tm\&.n\fR: Module API .TP \fBtomlish_module_tomlish\fR -\fIfiles/_module_tomlish-1\&.1\&.1\&.tm\&.n\fR: Module API +\fIfiles/_module_tomlish-1\&.1\&.1\&.tm\&.n\fR: tomlish toml parser diff --git a/src/embedded/md/.doc/tocdoc b/src/embedded/md/.doc/tocdoc index d57918ee..1a9f4aba 100644 --- a/src/embedded/md/.doc/tocdoc +++ b/src/embedded/md/.doc/tocdoc @@ -1,35 +1,42 @@ [toc_begin {Table Of Contents} doc] -[item doc/files/_module_modpod-0.1.0.tm.md modpod_module_modpod {Module API}] -[item doc/files/_module_overtype-1.6.3.tm.md overtype_module_overtype {overtype text layout - ansi aware}] -[item doc/files/_module_overtype-1.6.4.tm.md overtype_module_overtype {overtype text layout - ansi aware}] -[item doc/files/_module_overtype-1.6.5.tm.md overtype_module_overtype {overtype text layout - ansi aware}] -[item doc/files/main.md punkshell {punkshell - Core}] -[item doc/files/project_changes.md punkshell__project_changes {punkshell Changes}] -[item doc/files/project_intro.md punkshell__project_intro {Introduction to punkshell}] -[item doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi {Ansi string functions}] -[item doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args {args parsing}] -[item doc/files/punk/_module_cap-0.1.0.tm.md punkshell_module_punk::cap {capability provider and handler plugin system}] -[item doc/files/punk/_module_char-0.1.0.tm.md punkshell_module_punk::char {character-set and unicode utilities}] -[item doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::console {punk console}] -[item doc/files/punk/_module_encmime-0.1.0.tm.md punkshell_module_punk::encmime {mime encodings related subset of tcllib mime}] -[item doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline {file line-handling utilities}] -[item doc/files/punk/_module_flib-0.1.0.tm.md punkshell_module_punk::flib {flib experimental}] -[item doc/files/punk/_module_lib-0.1.1.tm.md punkshell_module_punk::lib {punk general utility functions}] -[item doc/files/punk/mix/commandset/_module_project-0.1.0.tm.md punkshell_module_punk::mix::commandset::project {dec commandset - project}] -[item doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::path {Filesystem path utilities}] -[item doc/files/_module_textblock-0.1.1.tm.md punkshell_module_textblock {punk textblock functions}] -[item doc/files/_module_argparsingtest-0.1.0.tm.md shellspy_module_argparsingtest {Module API}] -[item doc/files/_module_poshinfo-0.1.0.tm.md shellspy_module_poshinfo {Module API}] -[item doc/files/punk/_module_aliascore-0.1.0.tm.md shellspy_module_punk::aliascore {Module API}] -[item doc/files/punk/_module_assertion-0.1.0.tm.md shellspy_module_punk::assertion {assertion alternative to control::assert}] -[item doc/files/punk/_module_basictelnet-0.1.0.tm.md shellspy_module_punk::basictelnet {basic telnet client - DKF/Wiki}] -[item doc/files/punk/_module_experiment-0.1.0.tm.md shellspy_module_punk::experiment {Module API}] -[item doc/files/punk/_module_island-0.1.0.tm.md shellspy_module_punk::island {filesystem islands for safe interps}] -[item doc/files/punk/nav/_module_fs-0.1.0.tm.md shellspy_module_punk::nav::fs {Module API}] -[item doc/files/punk/_module_packagepreference-0.1.0.tm.md shellspy_module_punk::packagepreference {Module API}] -[item doc/files/punk/repl/_module_codethread-0.1.0.tm.md shellspy_module_punk::repl::codethread {Module API}] -[item doc/files/punk/_module_sshrun-0.1.0.tm.md shellspy_module_punk::sshrun {Tcl procedures to execute tcl scripts in remote hosts}] -[item doc/files/punk/_module_uc-0.1.0.tm.md shellspy_module_punk::uc {Module API}] -[item doc/files/punk/_module_zip-0.1.0.tm.md shellspy_module_punk::zip {Module API}] -[item doc/files/_module_tomlish-1.1.1.tm.md tomlish_module_tomlish {Module API}] +[item doc/files/_module_fauxlink-0.1.1.tm.md fauxlink_module_fauxlink {faux link application shortcuts}] +[item doc/files/_module_modpod-0.1.2.tm.md modpod_module_modpod {Module API}] +[item doc/files/_module_overtype-1.6.5.tm.md overtype_module_overtype {overtype text layout - ansi aware}] +[item doc/files/main.md punkshell {punkshell - Core}] +[item doc/files/punk/_module_basictelnet-0.1.0.tm.md punkshell::basictelnet {basic telnet client - DKF/Wiki}] +[item doc/files/project_changes.md punkshell__project_changes {punkshell Changes}] +[item doc/files/project_intro.md punkshell__project_intro {Introduction to punkshell}] +[item doc/files/_module_argparsingtest-0.1.0.tm.md punkshell_module_argparsingtest {Module API}] +[item doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_poshinfo {poshinfo prompt theme tool}] +[item doc/files/punk/_module_aliascore-0.1.0.tm.md punkshell_module_punk::aliascore {punkshell command aliases}] +[item doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi {Ansi string functions}] +[item doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args {args parsing}] +[item doc/files/punk/_module_assertion-0.1.0.tm.md punkshell_module_punk::assertion {assertion alternative to control::assert}] +[item doc/files/punk/_module_blockletter-0.1.0.tm.md punkshell_module_punk::blockletter {punk::blockletter frame-based large lettering test/logo}] +[item doc/files/punk/_module_cap-0.1.0.tm.md punkshell_module_punk::cap {capability provider and handler plugin system}] +[item doc/files/punk/_module_cesu-0.1.0.tm.md punkshell_module_punk::cesu {CESU compatibility ehcoding scheme for utf-16: 8-Bit (CESU-8) ??}] +[item doc/files/punk/_module_char-0.1.0.tm.md punkshell_module_punk::char {character-set and unicode utilities}] +[item doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::console {punk console}] +[item doc/files/punk/_module_encmime-0.1.0.tm.md punkshell_module_punk::encmime {mime encodings related subset of tcllib mime}] +[item doc/files/punk/_module_experiment-0.1.0.tm.md punkshell_module_punk::experiment {Module API}] +[item doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline {file line-handling utilities}] +[item doc/files/punk/_module_flib-0.1.0.tm.md punkshell_module_punk::flib {flib experimental}] +[item doc/files/punk/_module_island-0.1.0.tm.md punkshell_module_punk::island {filesystem islands for safe interps}] +[item doc/files/punk/_module_lib-0.1.1.tm.md punkshell_module_punk::lib {punk general utility functions}] +[item doc/files/punk/mix/commandset/_module_project-0.1.0.tm.md punkshell_module_punk::mix::commandset::project {dec commandset - project}] +[item doc/files/punk/_module_packagepreference-0.1.0.tm.md punkshell_module_punk::packagepreference {punkshell package/module loading}] +[item doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::path {Filesystem path utilities}] +[item doc/files/punk/_module_rest-0.1.0.tm.md punkshell_module_punk::rest punk::rest] +[item doc/files/punk/_module_sshrun-0.1.0.tm.md punkshell_module_punk::sshrun {Tcl procedures to execute tcl scripts in remote hosts}] +[item doc/files/punk/_module_trie-0.1.0.tm.md punkshell_module_punk::trie {punk::trie API}] +[item doc/files/punk/_module_uc-0.1.0.tm.md punkshell_module_punk::uc {Module API}] +[item doc/files/punk/_module_winlnk-0.1.0.tm.md punkshell_module_punk::winlnk {windows shortcut .lnk library}] +[item doc/files/punk/_module_zip-0.1.1.tm.md punkshell_module_punk::zip {Module API}] +[item doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md punkshell_module_scriptwrap {scriptwrap polyglot tool}] +[item doc/files/_module_textblock-0.1.1.tm.md punkshell_module_textblock {punk textblock functions}] +[item doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock {punk textblock functions}] +[item doc/files/punk/nav/_module_fs-0.1.0.tm.md shellspy_module_punk::nav::fs {punk::nav::fs console filesystem navigation}] +[item doc/files/punk/repl/_module_codethread-0.1.0.tm.md shellspy_module_punk::repl::codethread {Module repl codethread}] +[item doc/files/punk/_module_zip-0.1.0.tm.md shellspy_module_punk::zip {Module API}] +[item doc/files/_module_tomlish-1.1.1.tm.md tomlish_module_tomlish {tomlish toml parser}] [toc_end] diff --git a/src/embedded/md/.idx b/src/embedded/md/.idx index 3d1e020e..c707ed43 100644 --- a/src/embedded/md/.idx +++ b/src/embedded/md/.idx @@ -1 +1 @@ -{file {{doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline}} assertion {{doc/files/punk/_module_assertion-0.1.0.tm.md shellspy_module_punk::assertion}} encodings {{doc/files/punk/_module_encmime-0.1.0.tm.md punkshell_module_punk::encmime} {doc/files/punk/_module_char-0.1.0.tm.md punkshell_module_punk::char}} assert {{doc/files/punk/_module_assertion-0.1.0.tm.md shellspy_module_punk::assertion}} console {{doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::console} {doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi}} repl {{doc/files/project_intro.md punkshell__project_intro} {doc/files/main.md punkshell} {doc/files/project_changes.md punkshell__project_changes}} utility {{doc/files/punk/_module_lib-0.1.1.tm.md punkshell_module_punk::lib} {doc/files/_module_textblock-0.1.1.tm.md punkshell_module_textblock}} text {{doc/files/_module_overtype-1.6.3.tm.md overtype_module_overtype} {doc/files/_module_overtype-1.6.4.tm.md overtype_module_overtype} {doc/files/_module_overtype-1.6.5.tm.md overtype_module_overtype} {doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline}} arguments {{doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args}} BOM {{doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline}} experimental {{doc/files/punk/_module_flib-0.1.0.tm.md punkshell_module_punk::flib}} ssh {{doc/files/punk/_module_sshrun-0.1.0.tm.md shellspy_module_punk::sshrun}} debug {{doc/files/punk/_module_assertion-0.1.0.tm.md shellspy_module_punk::assertion}} encoding {{doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline}} shell {{doc/files/project_intro.md punkshell__project_intro} {doc/files/main.md punkshell} {doc/files/project_changes.md punkshell__project_changes}} changelog {{doc/files/project_changes.md punkshell__project_changes}} interp {{doc/files/punk/_module_island-0.1.0.tm.md shellspy_module_punk::island}} capability {{doc/files/punk/_module_cap-0.1.0.tm.md punkshell_module_punk::cap}} ansi {{doc/files/_module_overtype-1.6.3.tm.md overtype_module_overtype} {doc/files/_module_overtype-1.6.4.tm.md overtype_module_overtype} {doc/files/_module_overtype-1.6.5.tm.md overtype_module_overtype} {doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi}} parse {{doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline} {doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args}} terminal {{doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::console} {doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi}} proc {{doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args}} filesystem {{doc/files/punk/_module_island-0.1.0.tm.md shellspy_module_punk::island} {doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::path}} path {{doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::path}} args {{doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args}} punk {{doc/files/project_intro.md punkshell__project_intro} {doc/files/main.md punkshell} {doc/files/project_changes.md punkshell__project_changes}} module {{doc/files/punk/_module_uc-0.1.0.tm.md shellspy_module_punk::uc} {doc/files/punk/_module_lib-0.1.1.tm.md punkshell_module_punk::lib} {doc/files/punk/_module_assertion-0.1.0.tm.md shellspy_module_punk::assertion} {doc/files/punk/_module_experiment-0.1.0.tm.md shellspy_module_punk::experiment} {doc/files/_module_poshinfo-0.1.0.tm.md shellspy_module_poshinfo} {doc/files/_module_argparsingtest-0.1.0.tm.md shellspy_module_argparsingtest} {doc/files/_module_overtype-1.6.3.tm.md overtype_module_overtype} {doc/files/punk/_module_sshrun-0.1.0.tm.md shellspy_module_punk::sshrun} {doc/files/punk/_module_packagepreference-0.1.0.tm.md shellspy_module_punk::packagepreference} {doc/files/punk/_module_island-0.1.0.tm.md shellspy_module_punk::island} {doc/files/punk/_module_aliascore-0.1.0.tm.md shellspy_module_punk::aliascore} {doc/files/_module_overtype-1.6.4.tm.md overtype_module_overtype} {doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::console} {doc/files/_module_textblock-0.1.1.tm.md punkshell_module_textblock} {doc/files/_module_overtype-1.6.5.tm.md overtype_module_overtype} {doc/files/punk/_module_flib-0.1.0.tm.md punkshell_module_punk::flib} {doc/files/_module_tomlish-1.1.1.tm.md tomlish_module_tomlish} {doc/files/punk/_module_basictelnet-0.1.0.tm.md shellspy_module_punk::basictelnet} {doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline} {doc/files/punk/_module_zip-0.1.0.tm.md shellspy_module_punk::zip} {doc/files/punk/_module_cap-0.1.0.tm.md punkshell_module_punk::cap} {doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi} {doc/files/punk/repl/_module_codethread-0.1.0.tm.md shellspy_module_punk::repl::codethread} {doc/files/punk/nav/_module_fs-0.1.0.tm.md shellspy_module_punk::nav::fs} {doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::path} {doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args} {doc/files/punk/_module_encmime-0.1.0.tm.md punkshell_module_punk::encmime} {doc/files/punk/_module_char-0.1.0.tm.md punkshell_module_punk::char} {doc/files/_module_modpod-0.1.0.tm.md modpod_module_modpod}} lib {{doc/files/punk/_module_lib-0.1.1.tm.md punkshell_module_punk::lib} {doc/files/_module_textblock-0.1.1.tm.md punkshell_module_textblock}} plugin {{doc/files/punk/_module_cap-0.1.0.tm.md punkshell_module_punk::cap}} string {{doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi}}} {{module doc/files/_module_overtype-1.6.3.tm.md overtype_module_overtype} . {changelog doc/files/project_changes.md punkshell__project_changes} . {text doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline} . {shell doc/files/main.md punkshell} . {interp doc/files/punk/_module_island-0.1.0.tm.md shellspy_module_punk::island} . {string doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi} . {encoding doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline} . {filesystem doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::path} . {module doc/files/punk/_module_flib-0.1.0.tm.md punkshell_module_punk::flib} . {lib doc/files/_module_textblock-0.1.1.tm.md punkshell_module_textblock} . {module doc/files/punk/_module_encmime-0.1.0.tm.md punkshell_module_punk::encmime} . {module doc/files/_module_modpod-0.1.0.tm.md modpod_module_modpod} . {module doc/files/punk/repl/_module_codethread-0.1.0.tm.md shellspy_module_punk::repl::codethread} . {module doc/files/punk/_module_uc-0.1.0.tm.md shellspy_module_punk::uc} . {debug doc/files/punk/_module_assertion-0.1.0.tm.md shellspy_module_punk::assertion} . {arguments doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args} . {file doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline} . {shell doc/files/project_changes.md punkshell__project_changes} . {repl doc/files/project_intro.md punkshell__project_intro} . {module doc/files/punk/_module_cap-0.1.0.tm.md punkshell_module_punk::cap} . {utility doc/files/_module_textblock-0.1.1.tm.md punkshell_module_textblock} . {args doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args} . {path doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::path} . {module doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args} . {module doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::path} . {module doc/files/_module_poshinfo-0.1.0.tm.md shellspy_module_poshinfo} . {module doc/files/_module_argparsingtest-0.1.0.tm.md shellspy_module_argparsingtest} . {punk doc/files/main.md punkshell} . {module doc/files/punk/_module_assertion-0.1.0.tm.md shellspy_module_punk::assertion} . {encodings doc/files/punk/_module_char-0.1.0.tm.md punkshell_module_punk::char} . {repl doc/files/project_changes.md punkshell__project_changes} . {module doc/files/punk/_module_packagepreference-0.1.0.tm.md shellspy_module_punk::packagepreference} . {module doc/files/punk/_module_aliascore-0.1.0.tm.md shellspy_module_punk::aliascore} . {utility doc/files/punk/_module_lib-0.1.1.tm.md punkshell_module_punk::lib} . {parse doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args} . {module doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi} . {proc doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args} . {BOM doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline} . {plugin doc/files/punk/_module_cap-0.1.0.tm.md punkshell_module_punk::cap} . {module doc/files/punk/_module_basictelnet-0.1.0.tm.md shellspy_module_punk::basictelnet} . {punk doc/files/project_changes.md punkshell__project_changes} . {shell doc/files/project_intro.md punkshell__project_intro} . {module doc/files/punk/_module_sshrun-0.1.0.tm.md shellspy_module_punk::sshrun} . {module doc/files/punk/_module_island-0.1.0.tm.md shellspy_module_punk::island} . {module doc/files/punk/_module_lib-0.1.1.tm.md punkshell_module_punk::lib} . {text doc/files/_module_overtype-1.6.5.tm.md overtype_module_overtype} . {module doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline} . {encodings doc/files/punk/_module_encmime-0.1.0.tm.md punkshell_module_punk::encmime} . {assertion doc/files/punk/_module_assertion-0.1.0.tm.md shellspy_module_punk::assertion} . {experimental doc/files/punk/_module_flib-0.1.0.tm.md punkshell_module_punk::flib} . {module doc/files/_module_textblock-0.1.1.tm.md punkshell_module_textblock} . {repl doc/files/main.md punkshell} . {ansi doc/files/_module_overtype-1.6.5.tm.md overtype_module_overtype} . {terminal doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::console} . {text doc/files/_module_overtype-1.6.4.tm.md overtype_module_overtype} . {module doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::console} . {module doc/files/_module_overtype-1.6.5.tm.md overtype_module_overtype} . {module doc/files/punk/_module_experiment-0.1.0.tm.md shellspy_module_punk::experiment} . {console doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::console} . {ansi doc/files/_module_overtype-1.6.4.tm.md overtype_module_overtype} . {console doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi} . {module doc/files/punk/_module_char-0.1.0.tm.md punkshell_module_punk::char} . {text doc/files/_module_overtype-1.6.3.tm.md overtype_module_overtype} . {parse doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline} . {module doc/files/_module_overtype-1.6.4.tm.md overtype_module_overtype} . {lib doc/files/punk/_module_lib-0.1.1.tm.md punkshell_module_punk::lib} . {assert doc/files/punk/_module_assertion-0.1.0.tm.md shellspy_module_punk::assertion} . {punk doc/files/project_intro.md punkshell__project_intro} . {filesystem doc/files/punk/_module_island-0.1.0.tm.md shellspy_module_punk::island} . {ansi doc/files/_module_overtype-1.6.3.tm.md overtype_module_overtype} . {ssh doc/files/punk/_module_sshrun-0.1.0.tm.md shellspy_module_punk::sshrun} . {module doc/files/punk/_module_zip-0.1.0.tm.md shellspy_module_punk::zip} . {capability doc/files/punk/_module_cap-0.1.0.tm.md punkshell_module_punk::cap} . {ansi doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi} . {module doc/files/_module_tomlish-1.1.1.tm.md tomlish_module_tomlish} . {terminal doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi} . {module doc/files/punk/nav/_module_fs-0.1.0.tm.md shellspy_module_punk::nav::fs} .} 30 {assertion assertion file file assert assert encodings encodings repl repl console console utility utility text text ssh ssh experimental experimental BOM bom arguments arguments debug debug encoding encoding shell shell changelog changelog interp interp capability capability ansi ansi parse parse terminal terminal proc proc filesystem filesystem path path args args module module punk punk lib lib plugin plugin string string} \ No newline at end of file +{assertion {{doc/files/punk/_module_assertion-0.1.0.tm.md punkshell_module_punk::assertion}} fileformat {{doc/files/punk/_module_zip-0.1.1.tm.md punkshell_module_punk::zip}} POSH {{doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_poshinfo}} assert {{doc/files/punk/_module_assertion-0.1.0.tm.md punkshell_module_punk::assertion}} debug {{doc/files/punk/_module_assertion-0.1.0.tm.md punkshell_module_punk::assertion}} theme {{doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_poshinfo}} windows {{doc/files/punk/_module_winlnk-0.1.0.tm.md punkshell_module_punk::winlnk}} proc {{doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args}} filesystem {{doc/files/punk/_module_island-0.1.0.tm.md punkshell_module_punk::island} {doc/files/punk/nav/_module_fs-0.1.0.tm.md shellspy_module_punk::nav::fs} {doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::path}} layout {{doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock}} fake {{doc/files/_module_fauxlink-0.1.1.tm.md fauxlink_module_fauxlink}} datastructure {{doc/files/punk/_module_trie-0.1.0.tm.md punkshell_module_punk::trie}} utility {{doc/files/punk/_module_lib-0.1.1.tm.md punkshell_module_punk::lib} {doc/files/_module_textblock-0.1.1.tm.md punkshell_module_textblock}} wcswidth {{doc/files/punk/_module_uc-0.1.0.tm.md punkshell_module_punk::uc}} ssh {{doc/files/punk/_module_sshrun-0.1.0.tm.md punkshell_module_punk::sshrun}} rest {{doc/files/punk/_module_rest-0.1.0.tm.md punkshell_module_punk::rest}} scriptwrap {{doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md punkshell_module_scriptwrap}} changelog {{doc/files/project_changes.md punkshell__project_changes}} prompt {{doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_poshinfo}} launcher {{doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md punkshell_module_scriptwrap}} terminal {{doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_poshinfo} {doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::console} {doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock} {doc/files/punk/_module_basictelnet-0.1.0.tm.md punkshell::basictelnet} {doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi} {doc/files/punk/nav/_module_fs-0.1.0.tm.md shellspy_module_punk::nav::fs}} args {{doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args}} path {{doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::path}} crossplatform {{doc/files/punk/_module_winlnk-0.1.0.tm.md punkshell_module_punk::winlnk}} cesu {{doc/files/punk/_module_cesu-0.1.0.tm.md punkshell_module_punk::cesu}} unofficial {{doc/files/punk/_module_uc-0.1.0.tm.md punkshell_module_punk::uc} {doc/files/punk/_module_cesu-0.1.0.tm.md punkshell_module_punk::cesu}} configuration {{doc/files/_module_tomlish-1.1.1.tm.md tomlish_module_tomlish}} table {{doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock}} http {{doc/files/punk/_module_rest-0.1.0.tm.md punkshell_module_punk::rest}} file {{doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline}} encodings {{doc/files/punk/_module_encmime-0.1.0.tm.md punkshell_module_punk::encmime} {doc/files/punk/_module_char-0.1.0.tm.md punkshell_module_punk::char}} compatibility {{doc/files/punk/_module_cesu-0.1.0.tm.md punkshell_module_punk::cesu}} alias {{doc/files/punk/_module_aliascore-0.1.0.tm.md punkshell_module_punk::aliascore}} package {{doc/files/punk/_module_packagepreference-0.1.0.tm.md punkshell_module_punk::packagepreference}} parsing {{doc/files/_module_tomlish-1.1.1.tm.md tomlish_module_tomlish}} colour {{doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock}} {prompt theme} {{doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_poshinfo}} experimental {{doc/files/punk/_module_cesu-0.1.0.tm.md punkshell_module_punk::cesu} {doc/files/punk/_module_flib-0.1.0.tm.md punkshell_module_punk::flib}} shell {{doc/files/project_intro.md punkshell__project_intro} {doc/files/main.md punkshell} {doc/files/project_changes.md punkshell__project_changes}} capability {{doc/files/punk/_module_cap-0.1.0.tm.md punkshell_module_punk::cap}} parse {{doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline} {doc/files/punk/_module_winlnk-0.1.0.tm.md punkshell_module_punk::winlnk} {doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args}} commandset {{doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md punkshell_module_scriptwrap}} repl {{doc/files/project_intro.md punkshell__project_intro} {doc/files/main.md punkshell} {doc/files/punk/repl/_module_codethread-0.1.0.tm.md shellspy_module_punk::repl::codethread} {doc/files/project_changes.md punkshell__project_changes}} console {{doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_poshinfo} {doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::console} {doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock} {doc/files/punk/_module_basictelnet-0.1.0.tm.md punkshell::basictelnet} {doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi}} frame {{doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock}} toml {{doc/files/_module_tomlish-1.1.1.tm.md tomlish_module_tomlish} {doc/files/_module_fauxlink-0.1.1.tm.md fauxlink_module_fauxlink}} telnet {{doc/files/punk/_module_basictelnet-0.1.0.tm.md punkshell::basictelnet}} shortcut {{doc/files/_module_fauxlink-0.1.1.tm.md fauxlink_module_fauxlink} {doc/files/punk/_module_winlnk-0.1.0.tm.md punkshell_module_punk::winlnk}} text {{doc/files/_module_overtype-1.6.5.tm.md overtype_module_overtype} {doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock} {doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline}} lnk {{doc/files/punk/_module_winlnk-0.1.0.tm.md punkshell_module_punk::winlnk}} BOM {{doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline}} arguments {{doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args}} encoding {{doc/files/punk/_module_cesu-0.1.0.tm.md punkshell_module_punk::cesu} {doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline}} protocol {{doc/files/punk/_module_basictelnet-0.1.0.tm.md punkshell::basictelnet}} interp {{doc/files/punk/_module_island-0.1.0.tm.md punkshell_module_punk::island}} ansi {{doc/files/_module_overtype-1.6.5.tm.md overtype_module_overtype} {doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock} {doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi}} zip {{doc/files/punk/_module_zip-0.1.1.tm.md punkshell_module_punk::zip}} faux {{doc/files/_module_fauxlink-0.1.1.tm.md fauxlink_module_fauxlink}} trie {{doc/files/punk/_module_trie-0.1.0.tm.md punkshell_module_punk::trie}} punk {{doc/files/project_intro.md punkshell__project_intro} {doc/files/main.md punkshell} {doc/files/project_changes.md punkshell__project_changes}} module {{doc/files/punk/_module_uc-0.1.0.tm.md punkshell_module_punk::uc} {doc/files/punk/_module_lib-0.1.1.tm.md punkshell_module_punk::lib} {doc/files/punk/_module_cesu-0.1.0.tm.md punkshell_module_punk::cesu} {doc/files/punk/_module_assertion-0.1.0.tm.md punkshell_module_punk::assertion} {doc/files/_module_modpod-0.1.2.tm.md modpod_module_modpod} {doc/files/punk/_module_experiment-0.1.0.tm.md punkshell_module_punk::experiment} {doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_poshinfo} {doc/files/_module_argparsingtest-0.1.0.tm.md punkshell_module_argparsingtest} {doc/files/punk/_module_sshrun-0.1.0.tm.md punkshell_module_punk::sshrun} {doc/files/punk/_module_packagepreference-0.1.0.tm.md punkshell_module_punk::packagepreference} {doc/files/punk/_module_island-0.1.0.tm.md punkshell_module_punk::island} {doc/files/punk/_module_aliascore-0.1.0.tm.md punkshell_module_punk::aliascore} {doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::console} {doc/files/_module_textblock-0.1.1.tm.md punkshell_module_textblock} {doc/files/_module_overtype-1.6.5.tm.md overtype_module_overtype} {doc/files/punk/_module_flib-0.1.0.tm.md punkshell_module_punk::flib} {doc/files/_module_tomlish-1.1.1.tm.md tomlish_module_tomlish} {doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock} {doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md punkshell_module_scriptwrap} {doc/files/punk/_module_rest-0.1.0.tm.md punkshell_module_punk::rest} {doc/files/punk/_module_basictelnet-0.1.0.tm.md punkshell::basictelnet} {doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline} {doc/files/punk/_module_zip-0.1.0.tm.md shellspy_module_punk::zip} {doc/files/punk/_module_winlnk-0.1.0.tm.md punkshell_module_punk::winlnk} {doc/files/punk/_module_blockletter-0.1.0.tm.md punkshell_module_punk::blockletter} {doc/files/punk/_module_zip-0.1.1.tm.md punkshell_module_punk::zip} {doc/files/punk/_module_trie-0.1.0.tm.md punkshell_module_punk::trie} {doc/files/punk/_module_cap-0.1.0.tm.md punkshell_module_punk::cap} {doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi} {doc/files/punk/repl/_module_codethread-0.1.0.tm.md shellspy_module_punk::repl::codethread} {doc/files/punk/nav/_module_fs-0.1.0.tm.md shellspy_module_punk::nav::fs} {doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::path} {doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args} {doc/files/punk/_module_encmime-0.1.0.tm.md punkshell_module_punk::encmime} {doc/files/punk/_module_char-0.1.0.tm.md punkshell_module_punk::char}} symlink {{doc/files/_module_fauxlink-0.1.1.tm.md fauxlink_module_fauxlink}} unicode {{doc/files/punk/_module_uc-0.1.0.tm.md punkshell_module_punk::uc}} lib {{doc/files/punk/_module_lib-0.1.1.tm.md punkshell_module_punk::lib} {doc/files/_module_textblock-0.1.1.tm.md punkshell_module_textblock}} plugin {{doc/files/punk/_module_cap-0.1.0.tm.md punkshell_module_punk::cap}} string {{doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi}}} {{changelog doc/files/project_changes.md punkshell__project_changes} . {shell doc/files/main.md punkshell} . {text doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline} . {crossplatform doc/files/punk/_module_winlnk-0.1.0.tm.md punkshell_module_punk::winlnk} . {module doc/files/punk/_module_zip-0.1.1.tm.md punkshell_module_punk::zip} . {experimental doc/files/punk/_module_cesu-0.1.0.tm.md punkshell_module_punk::cesu} . {string doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi} . {encoding doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline} . {filesystem doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::path} . {module doc/files/punk/_module_flib-0.1.0.tm.md punkshell_module_punk::flib} . {lib doc/files/_module_textblock-0.1.1.tm.md punkshell_module_textblock} . {layout doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock} . {module doc/files/punk/_module_encmime-0.1.0.tm.md punkshell_module_punk::encmime} . {module doc/files/punk/_module_rest-0.1.0.tm.md punkshell_module_punk::rest} . {module doc/files/punk/repl/_module_codethread-0.1.0.tm.md shellspy_module_punk::repl::codethread} . {datastructure doc/files/punk/_module_trie-0.1.0.tm.md punkshell_module_punk::trie} . {table doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock} . {telnet doc/files/punk/_module_basictelnet-0.1.0.tm.md punkshell::basictelnet} . {arguments doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args} . {repl doc/files/punk/repl/_module_codethread-0.1.0.tm.md shellspy_module_punk::repl::codethread} . {file doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline} . {module doc/files/punk/_module_experiment-0.1.0.tm.md punkshell_module_punk::experiment} . {console doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_poshinfo} . {interp doc/files/punk/_module_island-0.1.0.tm.md punkshell_module_punk::island} . {parse doc/files/punk/_module_winlnk-0.1.0.tm.md punkshell_module_punk::winlnk} . {filesystem doc/files/punk/nav/_module_fs-0.1.0.tm.md shellspy_module_punk::nav::fs} . {zip doc/files/punk/_module_zip-0.1.1.tm.md punkshell_module_punk::zip} . {module doc/files/_module_argparsingtest-0.1.0.tm.md punkshell_module_argparsingtest} . {shell doc/files/project_changes.md punkshell__project_changes} . {trie doc/files/punk/_module_trie-0.1.0.tm.md punkshell_module_punk::trie} . {module doc/files/punk/_module_sshrun-0.1.0.tm.md punkshell_module_punk::sshrun} . {module doc/files/punk/_module_island-0.1.0.tm.md punkshell_module_punk::island} . {launcher doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md punkshell_module_scriptwrap} . {repl doc/files/project_intro.md punkshell__project_intro} . {module doc/files/punk/_module_cap-0.1.0.tm.md punkshell_module_punk::cap} . {module doc/files/punk/_module_trie-0.1.0.tm.md punkshell_module_punk::trie} . {utility doc/files/_module_textblock-0.1.1.tm.md punkshell_module_textblock} . {args doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args} . {path doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::path} . {debug doc/files/punk/_module_assertion-0.1.0.tm.md punkshell_module_punk::assertion} . {POSH doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_poshinfo} . {module doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args} . {module doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::path} . {text doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock} . {module doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md punkshell_module_scriptwrap} . {parsing doc/files/_module_tomlish-1.1.1.tm.md tomlish_module_tomlish} . {shortcut doc/files/punk/_module_winlnk-0.1.0.tm.md punkshell_module_punk::winlnk} . {punk doc/files/main.md punkshell} . {lnk doc/files/punk/_module_winlnk-0.1.0.tm.md punkshell_module_punk::winlnk} . {console doc/files/punk/_module_basictelnet-0.1.0.tm.md punkshell::basictelnet} . {module doc/files/punk/_module_assertion-0.1.0.tm.md punkshell_module_punk::assertion} . {module doc/files/punk/_module_uc-0.1.0.tm.md punkshell_module_punk::uc} . {module doc/files/punk/_module_cesu-0.1.0.tm.md punkshell_module_punk::cesu} . {encodings doc/files/punk/_module_char-0.1.0.tm.md punkshell_module_punk::char} . {unicode doc/files/punk/_module_uc-0.1.0.tm.md punkshell_module_punk::uc} . {repl doc/files/project_changes.md punkshell__project_changes} . {alias doc/files/punk/_module_aliascore-0.1.0.tm.md punkshell_module_punk::aliascore} . {terminal doc/files/punk/nav/_module_fs-0.1.0.tm.md shellspy_module_punk::nav::fs} . {assert doc/files/punk/_module_assertion-0.1.0.tm.md punkshell_module_punk::assertion} . {rest doc/files/punk/_module_rest-0.1.0.tm.md punkshell_module_punk::rest} . {filesystem doc/files/punk/_module_island-0.1.0.tm.md punkshell_module_punk::island} . {utility doc/files/punk/_module_lib-0.1.1.tm.md punkshell_module_punk::lib} . {module doc/files/punk/_module_winlnk-0.1.0.tm.md punkshell_module_punk::winlnk} . {module doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi} . {parse doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args} . {console doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock} . {frame doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock} . {toml doc/files/_module_fauxlink-0.1.1.tm.md fauxlink_module_fauxlink} . {shortcut doc/files/_module_fauxlink-0.1.1.tm.md fauxlink_module_fauxlink} . {BOM doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline} . {proc doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args} . {terminal doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock} . {plugin doc/files/punk/_module_cap-0.1.0.tm.md punkshell_module_punk::cap} . {theme doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_poshinfo} . {toml doc/files/_module_tomlish-1.1.1.tm.md tomlish_module_tomlish} . {{prompt theme} doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_poshinfo} . {shell doc/files/project_intro.md punkshell__project_intro} . {punk doc/files/project_changes.md punkshell__project_changes} . {ssh doc/files/punk/_module_sshrun-0.1.0.tm.md punkshell_module_punk::sshrun} . {http doc/files/punk/_module_rest-0.1.0.tm.md punkshell_module_punk::rest} . {module doc/files/punk/_module_lib-0.1.1.tm.md punkshell_module_punk::lib} . {text doc/files/_module_overtype-1.6.5.tm.md overtype_module_overtype} . {ansi doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock} . {commandset doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md punkshell_module_scriptwrap} . {faux doc/files/_module_fauxlink-0.1.1.tm.md fauxlink_module_fauxlink} . {module doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline} . {encodings doc/files/punk/_module_encmime-0.1.0.tm.md punkshell_module_punk::encmime} . {prompt doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_poshinfo} . {colour doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock} . {module doc/files/_module_textblock-0.1.1.tm.md punkshell_module_textblock} . {repl doc/files/main.md punkshell} . {experimental doc/files/punk/_module_flib-0.1.0.tm.md punkshell_module_punk::flib} . {symlink doc/files/_module_fauxlink-0.1.1.tm.md fauxlink_module_fauxlink} . {windows doc/files/punk/_module_winlnk-0.1.0.tm.md punkshell_module_punk::winlnk} . {terminal doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::console} . {module doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_poshinfo} . {ansi doc/files/_module_overtype-1.6.5.tm.md overtype_module_overtype} . {protocol doc/files/punk/_module_basictelnet-0.1.0.tm.md punkshell::basictelnet} . {module doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::console} . {wcswidth doc/files/punk/_module_uc-0.1.0.tm.md punkshell_module_punk::uc} . {configuration doc/files/_module_tomlish-1.1.1.tm.md tomlish_module_tomlish} . {module doc/files/_module_overtype-1.6.5.tm.md overtype_module_overtype} . {terminal doc/files/punk/_module_basictelnet-0.1.0.tm.md punkshell::basictelnet} . {encoding doc/files/punk/_module_cesu-0.1.0.tm.md punkshell_module_punk::cesu} . {module doc/files/punk/_module_basictelnet-0.1.0.tm.md punkshell::basictelnet} . {fileformat doc/files/punk/_module_zip-0.1.1.tm.md punkshell_module_punk::zip} . {module doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock} . {console doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::console} . {scriptwrap doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md punkshell_module_scriptwrap} . {console doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi} . {module doc/files/punk/_module_char-0.1.0.tm.md punkshell_module_punk::char} . {parse doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline} . {module doc/files/punk/_module_aliascore-0.1.0.tm.md punkshell_module_punk::aliascore} . {module doc/files/punk/_module_packagepreference-0.1.0.tm.md punkshell_module_punk::packagepreference} . {module doc/files/_module_modpod-0.1.2.tm.md modpod_module_modpod} . {module doc/files/punk/_module_blockletter-0.1.0.tm.md punkshell_module_punk::blockletter} . {lib doc/files/punk/_module_lib-0.1.1.tm.md punkshell_module_punk::lib} . {punk doc/files/project_intro.md punkshell__project_intro} . {assertion doc/files/punk/_module_assertion-0.1.0.tm.md punkshell_module_punk::assertion} . {unofficial doc/files/punk/_module_uc-0.1.0.tm.md punkshell_module_punk::uc} . {unofficial doc/files/punk/_module_cesu-0.1.0.tm.md punkshell_module_punk::cesu} . {cesu doc/files/punk/_module_cesu-0.1.0.tm.md punkshell_module_punk::cesu} . {terminal doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_poshinfo} . {fake doc/files/_module_fauxlink-0.1.1.tm.md fauxlink_module_fauxlink} . {package doc/files/punk/_module_packagepreference-0.1.0.tm.md punkshell_module_punk::packagepreference} . {compatibility doc/files/punk/_module_cesu-0.1.0.tm.md punkshell_module_punk::cesu} . {module doc/files/punk/_module_zip-0.1.0.tm.md shellspy_module_punk::zip} . {capability doc/files/punk/_module_cap-0.1.0.tm.md punkshell_module_punk::cap} . {ansi doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi} . {module doc/files/_module_tomlish-1.1.1.tm.md tomlish_module_tomlish} . {terminal doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi} . {module doc/files/punk/nav/_module_fs-0.1.0.tm.md shellspy_module_punk::nav::fs} .} 66 {assertion assertion fileformat fileformat assert assert POSH posh debug debug theme theme windows windows proc proc filesystem filesystem layout layout fake fake datastructure datastructure utility utility wcswidth wcswidth ssh ssh rest rest scriptwrap scriptwrap changelog changelog prompt prompt launcher launcher terminal terminal path path args args crossplatform crossplatform unofficial unofficial cesu cesu configuration configuration table table http http file file compatibility compatibility alias alias encodings encodings package package parsing parsing colour colour {prompt theme} prompt_theme experimental experimental shell shell capability capability commandset commandset parse parse repl repl console console frame frame toml toml telnet telnet shortcut shortcut text text lnk lnk BOM bom arguments arguments encoding encoding interp interp protocol protocol ansi ansi zip zip faux faux trie trie module module punk punk unicode unicode lib lib symlink symlink plugin plugin string string} \ No newline at end of file diff --git a/src/embedded/md/.toc b/src/embedded/md/.toc index 868b9ad9..c0c0d831 100644 --- a/src/embedded/md/.toc +++ b/src/embedded/md/.toc @@ -1 +1 @@ -doc {doc/toc {{doc/files/punk/_module_uc-0.1.0.tm.md shellspy_module_punk::uc {Module API}} {doc/files/punk/_module_lib-0.1.1.tm.md punkshell_module_punk::lib {punk general utility functions}} {doc/files/punk/_module_assertion-0.1.0.tm.md shellspy_module_punk::assertion {assertion alternative to control::assert}} {doc/files/project_intro.md punkshell__project_intro {Introduction to punkshell}} {doc/files/punk/_module_experiment-0.1.0.tm.md shellspy_module_punk::experiment {Module API}} {doc/files/_module_poshinfo-0.1.0.tm.md shellspy_module_poshinfo {Module API}} {doc/files/_module_argparsingtest-0.1.0.tm.md shellspy_module_argparsingtest {Module API}} {doc/files/_module_overtype-1.6.3.tm.md overtype_module_overtype {overtype text layout - ansi aware}} {doc/files/punk/_module_sshrun-0.1.0.tm.md shellspy_module_punk::sshrun {Tcl procedures to execute tcl scripts in remote hosts}} {doc/files/punk/_module_packagepreference-0.1.0.tm.md shellspy_module_punk::packagepreference {Module API}} {doc/files/punk/_module_island-0.1.0.tm.md shellspy_module_punk::island {filesystem islands for safe interps}} {doc/files/punk/_module_aliascore-0.1.0.tm.md shellspy_module_punk::aliascore {Module API}} {doc/files/main.md punkshell {punkshell - Core}} {doc/files/_module_overtype-1.6.4.tm.md overtype_module_overtype {overtype text layout - ansi aware}} {doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::console {punk console}} {doc/files/_module_textblock-0.1.1.tm.md punkshell_module_textblock {punk textblock functions}} {doc/files/_module_overtype-1.6.5.tm.md overtype_module_overtype {overtype text layout - ansi aware}} {doc/files/punk/_module_flib-0.1.0.tm.md punkshell_module_punk::flib {flib experimental}} {doc/files/_module_tomlish-1.1.1.tm.md tomlish_module_tomlish {Module API}} {doc/files/punk/mix/commandset/_module_project-0.1.0.tm.md punkshell_module_punk::mix::commandset::project {dec commandset - project}} {doc/files/punk/_module_basictelnet-0.1.0.tm.md shellspy_module_punk::basictelnet {basic telnet client - DKF/Wiki}} {doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline {file line-handling utilities}} {doc/files/punk/_module_zip-0.1.0.tm.md shellspy_module_punk::zip {Module API}} {doc/files/punk/_module_cap-0.1.0.tm.md punkshell_module_punk::cap {capability provider and handler plugin system}} {doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi {Ansi string functions}} {doc/files/punk/repl/_module_codethread-0.1.0.tm.md shellspy_module_punk::repl::codethread {Module API}} {doc/files/punk/nav/_module_fs-0.1.0.tm.md shellspy_module_punk::nav::fs {Module API}} {doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::path {Filesystem path utilities}} {doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args {args parsing}} {doc/files/project_changes.md punkshell__project_changes {punkshell Changes}} {doc/files/punk/_module_encmime-0.1.0.tm.md punkshell_module_punk::encmime {mime encodings related subset of tcllib mime}} {doc/files/punk/_module_char-0.1.0.tm.md punkshell_module_punk::char {character-set and unicode utilities}} {doc/files/_module_modpod-0.1.0.tm.md modpod_module_modpod {Module API}}}} \ No newline at end of file +doc {doc/toc {{doc/files/punk/_module_uc-0.1.0.tm.md punkshell_module_punk::uc {Module API}} {doc/files/punk/_module_lib-0.1.1.tm.md punkshell_module_punk::lib {punk general utility functions}} {doc/files/punk/_module_cesu-0.1.0.tm.md punkshell_module_punk::cesu {CESU compatibility ehcoding scheme for utf-16: 8-Bit (CESU-8) ??}} {doc/files/punk/_module_assertion-0.1.0.tm.md punkshell_module_punk::assertion {assertion alternative to control::assert}} {doc/files/project_intro.md punkshell__project_intro {Introduction to punkshell}} {doc/files/_module_modpod-0.1.2.tm.md modpod_module_modpod {Module API}} {doc/files/punk/_module_experiment-0.1.0.tm.md punkshell_module_punk::experiment {Module API}} {doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_poshinfo {poshinfo prompt theme tool}} {doc/files/_module_argparsingtest-0.1.0.tm.md punkshell_module_argparsingtest {Module API}} {doc/files/punk/_module_sshrun-0.1.0.tm.md punkshell_module_punk::sshrun {Tcl procedures to execute tcl scripts in remote hosts}} {doc/files/punk/_module_packagepreference-0.1.0.tm.md punkshell_module_punk::packagepreference {punkshell package/module loading}} {doc/files/punk/_module_island-0.1.0.tm.md punkshell_module_punk::island {filesystem islands for safe interps}} {doc/files/punk/_module_aliascore-0.1.0.tm.md punkshell_module_punk::aliascore {punkshell command aliases}} {doc/files/main.md punkshell {punkshell - Core}} {doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::console {punk console}} {doc/files/_module_textblock-0.1.1.tm.md punkshell_module_textblock {punk textblock functions}} {doc/files/_module_overtype-1.6.5.tm.md overtype_module_overtype {overtype text layout - ansi aware}} {doc/files/punk/_module_flib-0.1.0.tm.md punkshell_module_punk::flib {flib experimental}} {doc/files/_module_tomlish-1.1.1.tm.md tomlish_module_tomlish {tomlish toml parser}} {doc/files/_module_textblock-0.1.2.tm.md punkshell_module_textblock {punk textblock functions}} {doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md punkshell_module_scriptwrap {scriptwrap polyglot tool}} {doc/files/punk/mix/commandset/_module_project-0.1.0.tm.md punkshell_module_punk::mix::commandset::project {dec commandset - project}} {doc/files/punk/_module_rest-0.1.0.tm.md punkshell_module_punk::rest punk::rest} {doc/files/punk/_module_basictelnet-0.1.0.tm.md punkshell::basictelnet {basic telnet client - DKF/Wiki}} {doc/files/_module_fauxlink-0.1.1.tm.md fauxlink_module_fauxlink {faux link application shortcuts}} {doc/files/punk/_module_fileline-0.1.0.tm.md punkshell_module_punk::fileline {file line-handling utilities}} {doc/files/punk/_module_zip-0.1.0.tm.md shellspy_module_punk::zip {Module API}} {doc/files/punk/_module_winlnk-0.1.0.tm.md punkshell_module_punk::winlnk {windows shortcut .lnk library}} {doc/files/punk/_module_blockletter-0.1.0.tm.md punkshell_module_punk::blockletter {punk::blockletter frame-based large lettering test/logo}} {doc/files/punk/_module_zip-0.1.1.tm.md punkshell_module_punk::zip {Module API}} {doc/files/punk/_module_trie-0.1.0.tm.md punkshell_module_punk::trie {punk::trie API}} {doc/files/punk/_module_cap-0.1.0.tm.md punkshell_module_punk::cap {capability provider and handler plugin system}} {doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::ansi {Ansi string functions}} {doc/files/punk/repl/_module_codethread-0.1.0.tm.md shellspy_module_punk::repl::codethread {Module repl codethread}} {doc/files/punk/nav/_module_fs-0.1.0.tm.md shellspy_module_punk::nav::fs {punk::nav::fs console filesystem navigation}} {doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::path {Filesystem path utilities}} {doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::args {args parsing}} {doc/files/project_changes.md punkshell__project_changes {punkshell Changes}} {doc/files/punk/_module_encmime-0.1.0.tm.md punkshell_module_punk::encmime {mime encodings related subset of tcllib mime}} {doc/files/punk/_module_char-0.1.0.tm.md punkshell_module_punk::char {character-set and unicode utilities}}}} \ No newline at end of file diff --git a/src/embedded/md/.xrf b/src/embedded/md/.xrf index ceeab52e..90b5f1c2 100644 --- a/src/embedded/md/.xrf +++ b/src/embedded/md/.xrf @@ -1 +1 @@ -punkshell_module_punk::path(0) doc/files/punk/_module_path-0.1.0.tm.md sa,shellspy_module_punk::island doc/files/punk/_module_island-0.1.0.tm.md sa,punkshell_module_punk::mix::commandset::project(0) doc/files/punk/mix/commandset/_module_project-0.1.0.tm.md kw,lib {index.md lib} shellspy_module_punk::packagepreference(0) doc/files/punk/_module_packagepreference-0.1.0.tm.md debug {index.md debug} punkshell_module_punk::console(0) doc/files/punk/_module_console-0.1.1.tm.md {basic telnet client - DKF/Wiki} doc/files/punk/_module_basictelnet-0.1.0.tm.md shellspy_module_punk::island doc/files/punk/_module_island-0.1.0.tm.md sa,punkshell_module_punk::fileline(0) doc/files/punk/_module_fileline-0.1.0.tm.md filesystem {index.md filesystem} sa,punkshell_module_punk::cap doc/files/punk/_module_cap-0.1.0.tm.md kw,interp {index.md interp} sa,punkshell_module_punk::cap(0) doc/files/punk/_module_cap-0.1.0.tm.md sa,shellspy_module_punk::assertion doc/files/punk/_module_assertion-0.1.0.tm.md kw,terminal {index.md terminal} kw,path {index.md path} utility {index.md utility} sa,shellspy_module_argparsingtest doc/files/_module_argparsingtest-0.1.0.tm.md kw,assert {index.md assert} changelog {index.md changelog} shellspy_module_punk::uc(0) doc/files/punk/_module_uc-0.1.0.tm.md path {index.md path} shellspy_module_punk::basictelnet doc/files/punk/_module_basictelnet-0.1.0.tm.md sa,punkshell_module_punk::path doc/files/punk/_module_path-0.1.0.tm.md sa,shellspy_module_punk::uc doc/files/punk/_module_uc-0.1.0.tm.md sa,punkshell_module_punk::lib doc/files/punk/_module_lib-0.1.1.tm.md sa,punkshell_module_punk::mix::commandset::project doc/files/punk/mix/commandset/_module_project-0.1.0.tm.md shellspy_module_punk::aliascore(0) doc/files/punk/_module_aliascore-0.1.0.tm.md sa,shellspy_module_argparsingtest(0) doc/files/_module_argparsingtest-0.1.0.tm.md {Module API} doc/files/_module_modpod-0.1.0.tm.md sa,punkshell_module_punk::ansi(0) doc/files/punk/_module_ansi-0.1.1.tm.md punkshell_module_punk::args doc/files/punk/_module_args-0.1.0.tm.md shellspy_module_punk::uc doc/files/punk/_module_uc-0.1.0.tm.md capability {index.md capability} punkshell_module_punk::encmime(0) doc/files/punk/_module_encmime-0.1.0.tm.md parse {index.md parse} sa,punkshell_module_punk::lib(0) doc/files/punk/_module_lib-0.1.1.tm.md {punkshell - Core} doc/files/main.md {capability provider and handler plugin system} doc/files/punk/_module_cap-0.1.0.tm.md sa,punkshell_module_punk::encmime doc/files/punk/_module_encmime-0.1.0.tm.md shellspy_module_punk::experiment(0) doc/files/punk/_module_experiment-0.1.0.tm.md punkshell_module_punk::fileline doc/files/punk/_module_fileline-0.1.0.tm.md kw,punk {index.md punk} tomlish_module_tomlish(0) doc/files/_module_tomlish-1.1.1.tm.md {Filesystem path utilities} doc/files/punk/_module_path-0.1.0.tm.md arguments {index.md arguments} interp {index.md interp} sa,shellspy_module_punk::repl::codethread doc/files/punk/repl/_module_codethread-0.1.0.tm.md punk {index.md punk} lib {index.md lib} sa,punkshell_module_textblock doc/files/_module_textblock-0.1.1.tm.md punkshell_module_punk::args(0) doc/files/punk/_module_args-0.1.0.tm.md assert {index.md assert} kw,proc {index.md proc} {flib experimental} doc/files/punk/_module_flib-0.1.0.tm.md punkshell_module_punk::ansi doc/files/punk/_module_ansi-0.1.1.tm.md kw,encodings {index.md encodings} shellspy_module_punk::assertion(0) doc/files/punk/_module_assertion-0.1.0.tm.md sa,tomlish_module_tomlish doc/files/_module_tomlish-1.1.1.tm.md sa,shellspy_module_punk::nav::fs doc/files/punk/nav/_module_fs-0.1.0.tm.md proc {index.md proc} sa,punkshell doc/files/main.md kw,shell {index.md shell} {punk console} doc/files/punk/_module_console-0.1.1.tm.md sa,punkshell_module_punk::flib(0) doc/files/punk/_module_flib-0.1.0.tm.md sa,punkshell__project_changes(n) doc/files/project_changes.md sa,shellspy_module_punk::uc(0) doc/files/punk/_module_uc-0.1.0.tm.md kw,args {index.md args} punkshell_module_punk::cap(0) doc/files/punk/_module_cap-0.1.0.tm.md terminal {index.md terminal} sa,shellspy_module_punk::repl::codethread(0) doc/files/punk/repl/_module_codethread-0.1.0.tm.md args {index.md args} punkshell_module_punk::console doc/files/punk/_module_console-0.1.1.tm.md sa,punkshell_module_punk::args doc/files/punk/_module_args-0.1.0.tm.md sa,shellspy_module_punk::experiment doc/files/punk/_module_experiment-0.1.0.tm.md punkshell__project_changes doc/files/project_changes.md sa,punkshell_module_punk::char(0) doc/files/punk/_module_char-0.1.0.tm.md shellspy_module_punk::sshrun(0) doc/files/punk/_module_sshrun-0.1.0.tm.md experimental {index.md experimental} shellspy_module_punk::experiment doc/files/punk/_module_experiment-0.1.0.tm.md sa,shellspy_module_punk::experiment(0) doc/files/punk/_module_experiment-0.1.0.tm.md sa,punkshell_module_punk::fileline doc/files/punk/_module_fileline-0.1.0.tm.md sa,shellspy_module_punk::zip doc/files/punk/_module_zip-0.1.0.tm.md kw,encoding {index.md encoding} shellspy_module_argparsingtest(0) doc/files/_module_argparsingtest-0.1.0.tm.md kw,ansi {index.md ansi} sa,punkshell_module_textblock(0) doc/files/_module_textblock-0.1.1.tm.md console {index.md console} punkshell_module_punk::lib(0) doc/files/punk/_module_lib-0.1.1.tm.md sa,punkshell__project_intro doc/files/project_intro.md sa,punkshell_module_punk::path(0) doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::char doc/files/punk/_module_char-0.1.0.tm.md ansi {index.md ansi} punkshell__project_intro(n) doc/files/project_intro.md punkshell__project_intro doc/files/project_intro.md sa,shellspy_module_punk::packagepreference(0) doc/files/punk/_module_packagepreference-0.1.0.tm.md kw,changelog {index.md changelog} sa,punkshell_module_punk::ansi doc/files/punk/_module_ansi-0.1.1.tm.md assertion {index.md assertion} punkshell_module_punk::flib doc/files/punk/_module_flib-0.1.0.tm.md shellspy_module_punk::island(0) doc/files/punk/_module_island-0.1.0.tm.md {punk general utility functions} doc/files/punk/_module_lib-0.1.1.tm.md shellspy_module_punk::packagepreference doc/files/punk/_module_packagepreference-0.1.0.tm.md punkshell_module_punk::mix::commandset::project(0) doc/files/punk/mix/commandset/_module_project-0.1.0.tm.md shellspy_module_poshinfo(0) doc/files/_module_poshinfo-0.1.0.tm.md shellspy_module_punk::nav::fs doc/files/punk/nav/_module_fs-0.1.0.tm.md kw,module {index.md module} punkshell_module_punk::fileline(0) doc/files/punk/_module_fileline-0.1.0.tm.md kw,plugin {index.md plugin} punkshell doc/files/main.md punkshell_module_punk::cap doc/files/punk/_module_cap-0.1.0.tm.md sa,shellspy_module_punk::basictelnet(0) doc/files/punk/_module_basictelnet-0.1.0.tm.md punkshell__project_changes(n) doc/files/project_changes.md kw,utility {index.md utility} kw,arguments {index.md arguments} kw,ssh {index.md ssh} shellspy_module_argparsingtest doc/files/_module_argparsingtest-0.1.0.tm.md sa,shellspy_module_punk::sshrun(0) doc/files/punk/_module_sshrun-0.1.0.tm.md sa,shellspy_module_punk::aliascore(0) doc/files/punk/_module_aliascore-0.1.0.tm.md shellspy_module_punk::basictelnet(0) doc/files/punk/_module_basictelnet-0.1.0.tm.md kw,filesystem {index.md filesystem} shellspy_module_punk::repl::codethread(0) doc/files/punk/repl/_module_codethread-0.1.0.tm.md sa,overtype_module_overtype doc/files/_module_overtype-1.6.5.tm.md shell {index.md shell} {assertion alternative to control::assert} doc/files/punk/_module_assertion-0.1.0.tm.md punkshell_module_punk::lib doc/files/punk/_module_lib-0.1.1.tm.md shellspy_module_punk::aliascore doc/files/punk/_module_aliascore-0.1.0.tm.md kw,debug {index.md debug} {punk textblock functions} doc/files/_module_textblock-0.1.1.tm.md overtype_module_overtype doc/files/_module_overtype-1.6.5.tm.md punkshell_module_punk::ansi(0) doc/files/punk/_module_ansi-0.1.1.tm.md overtype_module_overtype(0) doc/files/_module_overtype-1.6.5.tm.md sa,punkshell_module_punk::char doc/files/punk/_module_char-0.1.0.tm.md sa,punkshell__project_intro(n) doc/files/project_intro.md shellspy_module_punk::zip doc/files/punk/_module_zip-0.1.0.tm.md sa,shellspy_module_poshinfo doc/files/_module_poshinfo-0.1.0.tm.md encoding {index.md encoding} sa,punkshell_module_punk::flib doc/files/punk/_module_flib-0.1.0.tm.md sa,punkshell_module_punk::args(0) doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::encmime doc/files/punk/_module_encmime-0.1.0.tm.md punkshell_module_textblock(0) doc/files/_module_textblock-0.1.1.tm.md modpod_module_modpod(0) doc/files/_module_modpod-0.1.0.tm.md kw,BOM {index.md bom} shellspy_module_poshinfo doc/files/_module_poshinfo-0.1.0.tm.md sa,shellspy_module_punk::island(0) doc/files/punk/_module_island-0.1.0.tm.md {file line-handling utilities} doc/files/punk/_module_fileline-0.1.0.tm.md module {index.md module} plugin {index.md plugin} sa,punkshell_module_punk::console(0) doc/files/punk/_module_console-0.1.1.tm.md kw,capability {index.md capability} sa,modpod_module_modpod doc/files/_module_modpod-0.1.0.tm.md sa,shellspy_module_punk::assertion(0) doc/files/punk/_module_assertion-0.1.0.tm.md shellspy_module_punk::repl::codethread doc/files/punk/repl/_module_codethread-0.1.0.tm.md sa,shellspy_module_punk::packagepreference doc/files/punk/_module_packagepreference-0.1.0.tm.md sa,shellspy_module_poshinfo(0) doc/files/_module_poshinfo-0.1.0.tm.md {punkshell Changes} doc/files/project_changes.md punkshell_module_textblock doc/files/_module_textblock-0.1.1.tm.md modpod_module_modpod doc/files/_module_modpod-0.1.0.tm.md {Introduction to punkshell} doc/files/project_intro.md sa,punkshell(n) doc/files/main.md {mime encodings related subset of tcllib mime} doc/files/punk/_module_encmime-0.1.0.tm.md kw,parse {index.md parse} tomlish_module_tomlish doc/files/_module_tomlish-1.1.1.tm.md punkshell(n) doc/files/main.md kw,string {index.md string} kw,file {index.md file} ssh {index.md ssh} sa,punkshell_module_punk::console doc/files/punk/_module_console-0.1.1.tm.md sa,shellspy_module_punk::basictelnet doc/files/punk/_module_basictelnet-0.1.0.tm.md shellspy_module_punk::assertion doc/files/punk/_module_assertion-0.1.0.tm.md punkshell_module_punk::flib(0) doc/files/punk/_module_flib-0.1.0.tm.md {dec commandset - project} doc/files/punk/mix/commandset/_module_project-0.1.0.tm.md sa,punkshell__project_changes doc/files/project_changes.md kw,experimental {index.md experimental} file {index.md file} {args parsing} doc/files/punk/_module_args-0.1.0.tm.md encodings {index.md encodings} {Ansi string functions} doc/files/punk/_module_ansi-0.1.1.tm.md sa,punkshell_module_punk::encmime(0) doc/files/punk/_module_encmime-0.1.0.tm.md sa,shellspy_module_punk::sshrun doc/files/punk/_module_sshrun-0.1.0.tm.md sa,shellspy_module_punk::aliascore doc/files/punk/_module_aliascore-0.1.0.tm.md sa,shellspy_module_punk::zip(0) doc/files/punk/_module_zip-0.1.0.tm.md kw,assertion {index.md assertion} sa,overtype_module_overtype(0) doc/files/_module_overtype-1.6.5.tm.md {overtype text layout - ansi aware} doc/files/_module_overtype-1.6.5.tm.md punkshell_module_punk::path doc/files/punk/_module_path-0.1.0.tm.md kw,repl {index.md repl} punkshell_module_punk::char(0) doc/files/punk/_module_char-0.1.0.tm.md kw,text {index.md text} {Tcl procedures to execute tcl scripts in remote hosts} doc/files/punk/_module_sshrun-0.1.0.tm.md punkshell_module_punk::mix::commandset::project doc/files/punk/mix/commandset/_module_project-0.1.0.tm.md shellspy_module_punk::sshrun doc/files/punk/_module_sshrun-0.1.0.tm.md sa,tomlish_module_tomlish(0) doc/files/_module_tomlish-1.1.1.tm.md sa,shellspy_module_punk::nav::fs(0) doc/files/punk/nav/_module_fs-0.1.0.tm.md {filesystem islands for safe interps} doc/files/punk/_module_island-0.1.0.tm.md shellspy_module_punk::zip(0) doc/files/punk/_module_zip-0.1.0.tm.md sa,modpod_module_modpod(0) doc/files/_module_modpod-0.1.0.tm.md repl {index.md repl} shellspy_module_punk::nav::fs(0) doc/files/punk/nav/_module_fs-0.1.0.tm.md text {index.md text} BOM {index.md bom} kw,console {index.md console} {character-set and unicode utilities} doc/files/punk/_module_char-0.1.0.tm.md string {index.md string} \ No newline at end of file +punkshell_module_scriptwrap doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md sa,fauxlink_module_fauxlink(0) doc/files/_module_fauxlink-0.1.1.tm.md sa,punkshell_module_punk::trie(0) doc/files/punk/_module_trie-0.1.0.tm.md fileformat {index.md fileformat} punkshell_module_punk::path(0) doc/files/punk/_module_path-0.1.0.tm.md POSH {index.md posh} sa,punkshell_module_punk::assertion(0) doc/files/punk/_module_assertion-0.1.0.tm.md sa,punkshell_module_punk::experiment doc/files/punk/_module_experiment-0.1.0.tm.md sa,punkshell_module_punk::mix::commandset::project(0) doc/files/punk/mix/commandset/_module_project-0.1.0.tm.md kw,lib {index.md lib} kw,configuration {index.md configuration} kw,table {index.md table} debug {index.md debug} punkshell_module_punk::packagepreference(0) doc/files/punk/_module_packagepreference-0.1.0.tm.md punkshell_module_punk::console(0) doc/files/punk/_module_console-0.1.1.tm.md kw,compatibility {index.md compatibility} {basic telnet client - DKF/Wiki} doc/files/punk/_module_basictelnet-0.1.0.tm.md windows {index.md windows} kw,wcswidth {index.md wcswidth} kw,rest {index.md rest} sa,punkshell_module_punk::fileline(0) doc/files/punk/_module_fileline-0.1.0.tm.md filesystem {index.md filesystem} sa,punkshell_module_punk::cap doc/files/punk/_module_cap-0.1.0.tm.md kw,interp {index.md interp} sa,punkshell_module_punk::cap(0) doc/files/punk/_module_cap-0.1.0.tm.md kw,terminal {index.md terminal} punkshell_module_punk::rest(0) doc/files/punk/_module_rest-0.1.0.tm.md kw,path {index.md path} utility {index.md utility} rest {index.md rest} sa,punkshell_module_argparsingtest doc/files/_module_argparsingtest-0.1.0.tm.md kw,assert {index.md assert} changelog {index.md changelog} sa,punkshell_module_punk::rest doc/files/punk/_module_rest-0.1.0.tm.md path {index.md path} punkshell_module_poshinfo doc/files/_module_poshinfo-0.1.0.tm.md unofficial {index.md unofficial} sa,punkshell_module_punk::path doc/files/punk/_module_path-0.1.0.tm.md sa,punkshell_module_punk::lib doc/files/punk/_module_lib-0.1.1.tm.md {CESU compatibility ehcoding scheme for utf-16: 8-Bit (CESU-8) ??} doc/files/punk/_module_cesu-0.1.0.tm.md sa,punkshell_module_punk::assertion doc/files/punk/_module_assertion-0.1.0.tm.md sa,punkshell_module_punk::mix::commandset::project doc/files/punk/mix/commandset/_module_project-0.1.0.tm.md package {index.md package} parsing {index.md parsing} sa,punkshell_module_punk::uc(0) doc/files/punk/_module_uc-0.1.0.tm.md {faux link application shortcuts} doc/files/_module_fauxlink-0.1.1.tm.md punkshell_module_punk::zip doc/files/punk/_module_zip-0.1.1.tm.md {Module API} doc/files/punk/_module_zip-0.1.1.tm.md {punk::trie API} doc/files/punk/_module_trie-0.1.0.tm.md sa,punkshell_module_punk::ansi(0) doc/files/punk/_module_ansi-0.1.1.tm.md {poshinfo prompt theme tool} doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_punk::args doc/files/punk/_module_args-0.1.0.tm.md capability {index.md capability} kw,shortcut {index.md shortcut} punkshell_module_punk::encmime(0) doc/files/punk/_module_encmime-0.1.0.tm.md parse {index.md parse} sa,punkshell_module_punk::lib(0) doc/files/punk/_module_lib-0.1.1.tm.md punkshell_module_punk::cesu doc/files/punk/_module_cesu-0.1.0.tm.md punkshell_module_punk::assertion doc/files/punk/_module_assertion-0.1.0.tm.md {punkshell - Core} doc/files/main.md punkshell_module_punk::uc(0) doc/files/punk/_module_uc-0.1.0.tm.md {capability provider and handler plugin system} doc/files/punk/_module_cap-0.1.0.tm.md sa,punkshell_module_punk::encmime doc/files/punk/_module_encmime-0.1.0.tm.md punkshell_module_punk::fileline doc/files/punk/_module_fileline-0.1.0.tm.md kw,punk {index.md punk} tomlish_module_tomlish(0) doc/files/_module_tomlish-1.1.1.tm.md {Filesystem path utilities} doc/files/punk/_module_path-0.1.0.tm.md arguments {index.md arguments} {punkshell command aliases} doc/files/punk/_module_aliascore-0.1.0.tm.md punk::rest doc/files/punk/_module_rest-0.1.0.tm.md sa,punkshell_module_scriptwrap doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md kw,colour {index.md colour} interp {index.md interp} protocol {index.md protocol} kw,lnk {index.md lnk} sa,shellspy_module_punk::repl::codethread doc/files/punk/repl/_module_codethread-0.1.0.tm.md punk {index.md punk} lib {index.md lib} sa,punkshell_module_punk::packagepreference(0) doc/files/punk/_module_packagepreference-0.1.0.tm.md sa,punkshell_module_textblock doc/files/_module_textblock-0.1.2.tm.md punkshell_module_punk::args(0) doc/files/punk/_module_args-0.1.0.tm.md assert {index.md assert} kw,proc {index.md proc} {flib experimental} doc/files/punk/_module_flib-0.1.0.tm.md sa,punkshell_module_punk::uc doc/files/punk/_module_uc-0.1.0.tm.md sa,punkshell_module_punk::cesu(0) doc/files/punk/_module_cesu-0.1.0.tm.md kw,fake {index.md fake} kw,unicode {index.md unicode} kw,symlink {index.md symlink} sa,punkshell_module_punk::sshrun doc/files/punk/_module_sshrun-0.1.0.tm.md punkshell_module_punk::blockletter doc/files/punk/_module_blockletter-0.1.0.tm.md punkshell_module_punk::ansi doc/files/punk/_module_ansi-0.1.1.tm.md sa,punkshell::basictelnet doc/files/punk/_module_basictelnet-0.1.0.tm.md sa,punkshell_module_punk::zip(0) doc/files/punk/_module_zip-0.1.1.tm.md punkshell_module_punk::trie doc/files/punk/_module_trie-0.1.0.tm.md kw,encodings {index.md encodings} kw,alias {index.md alias} kw,telnet {index.md telnet} theme {index.md theme} sa,tomlish_module_tomlish doc/files/_module_tomlish-1.1.1.tm.md sa,shellspy_module_punk::nav::fs doc/files/punk/nav/_module_fs-0.1.0.tm.md proc {index.md proc} punkshell_module_punk::experiment doc/files/punk/_module_experiment-0.1.0.tm.md sa,punkshell doc/files/main.md kw,shell {index.md shell} fake {index.md fake} kw,launcher {index.md launcher} {punk console} doc/files/punk/_module_console-0.1.1.tm.md sa,punkshell_module_punk::flib(0) doc/files/punk/_module_flib-0.1.0.tm.md sa,punkshell__project_changes(n) doc/files/project_changes.md datastructure {index.md datastructure} kw,args {index.md args} {punk::nav::fs console filesystem navigation} doc/files/punk/nav/_module_fs-0.1.0.tm.md {punk::blockletter frame-based large lettering test/logo} doc/files/punk/_module_blockletter-0.1.0.tm.md wcswidth {index.md wcswidth} kw,cesu {index.md cesu} kw,http {index.md http} sa,punkshell_module_punk::packagepreference doc/files/punk/_module_packagepreference-0.1.0.tm.md scriptwrap {index.md scriptwrap} punkshell_module_punk::cap(0) doc/files/punk/_module_cap-0.1.0.tm.md kw,frame {index.md frame} punkshell_module_scriptwrap(0) doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md terminal {index.md terminal} sa,shellspy_module_punk::repl::codethread(0) doc/files/punk/repl/_module_codethread-0.1.0.tm.md args {index.md args} punkshell_module_punk::packagepreference doc/files/punk/_module_packagepreference-0.1.0.tm.md punkshell_module_punk::console doc/files/punk/_module_console-0.1.1.tm.md cesu {index.md cesu} table {index.md table} http {index.md http} punkshell_module_argparsingtest(0) doc/files/_module_argparsingtest-0.1.0.tm.md sa,punkshell_module_punk::args doc/files/punk/_module_args-0.1.0.tm.md punkshell__project_changes doc/files/project_changes.md sa,punkshell_module_punk::char(0) doc/files/punk/_module_char-0.1.0.tm.md sa,punkshell_module_punk::cesu doc/files/punk/_module_cesu-0.1.0.tm.md kw,layout {index.md layout} colour {index.md colour} {prompt theme} {index.md prompt_theme} experimental {index.md experimental} sa,punkshell_module_punk::island doc/files/punk/_module_island-0.1.0.tm.md sa,punkshell_module_punk::blockletter(0) doc/files/punk/_module_blockletter-0.1.0.tm.md sa,punkshell_module_punk::fileline doc/files/punk/_module_fileline-0.1.0.tm.md sa,shellspy_module_punk::zip doc/files/punk/_module_zip-0.1.0.tm.md kw,encoding {index.md encoding} {windows shortcut .lnk library} doc/files/punk/_module_winlnk-0.1.0.tm.md kw,prompt {index.md prompt} kw,ansi {index.md ansi} kw,trie {index.md trie} sa,punkshell_module_textblock(0) doc/files/_module_textblock-0.1.2.tm.md console {index.md console} punkshell_module_punk::lib(0) doc/files/punk/_module_lib-0.1.1.tm.md telnet {index.md telnet} shortcut {index.md shortcut} lnk {index.md lnk} sa,punkshell__project_intro doc/files/project_intro.md kw,datastructure {index.md datastructure} sa,punkshell_module_punk::path(0) doc/files/punk/_module_path-0.1.0.tm.md punkshell_module_punk::char doc/files/punk/_module_char-0.1.0.tm.md ansi {index.md ansi} trie {index.md trie} punkshell__project_intro(n) doc/files/project_intro.md punkshell__project_intro doc/files/project_intro.md kw,changelog {index.md changelog} sa,punkshell_module_punk::ansi doc/files/punk/_module_ansi-0.1.1.tm.md sa,fauxlink_module_fauxlink doc/files/_module_fauxlink-0.1.1.tm.md sa,punkshell_module_punk::trie doc/files/punk/_module_trie-0.1.0.tm.md assertion {index.md assertion} punkshell_module_punk::flib doc/files/punk/_module_flib-0.1.0.tm.md kw,commandset {index.md commandset} kw,zip {index.md zip} fauxlink_module_fauxlink doc/files/_module_fauxlink-0.1.1.tm.md {punk general utility functions} doc/files/punk/_module_lib-0.1.1.tm.md {tomlish toml parser} doc/files/_module_tomlish-1.1.1.tm.md sa,punkshell::basictelnet(0) doc/files/punk/_module_basictelnet-0.1.0.tm.md punkshell_module_punk::trie(0) doc/files/punk/_module_trie-0.1.0.tm.md sa,punkshell_module_punk::rest(0) doc/files/punk/_module_rest-0.1.0.tm.md punkshell_module_punk::uc doc/files/punk/_module_uc-0.1.0.tm.md punkshell_module_punk::mix::commandset::project(0) doc/files/punk/mix/commandset/_module_project-0.1.0.tm.md layout {index.md layout} punkshell_module_punk::sshrun doc/files/punk/_module_sshrun-0.1.0.tm.md sa,punkshell_module_punk::winlnk doc/files/punk/_module_winlnk-0.1.0.tm.md punkshell_module_punk::zip(0) doc/files/punk/_module_zip-0.1.1.tm.md kw,windows {index.md windows} shellspy_module_punk::nav::fs doc/files/punk/nav/_module_fs-0.1.0.tm.md kw,module {index.md module} punkshell_module_punk::fileline(0) doc/files/punk/_module_fileline-0.1.0.tm.md kw,plugin {index.md plugin} punkshell doc/files/main.md kw,fileformat {index.md fileformat} punkshell_module_punk::cap doc/files/punk/_module_cap-0.1.0.tm.md sa,punkshell_module_poshinfo(0) doc/files/_module_poshinfo-0.1.0.tm.md punkshell__project_changes(n) doc/files/project_changes.md kw,utility {index.md utility} prompt {index.md prompt} launcher {index.md launcher} kw,ssh {index.md ssh} kw,arguments {index.md arguments} {punkshell package/module loading} doc/files/punk/_module_packagepreference-0.1.0.tm.md sa,punkshell_module_punk::zip doc/files/punk/_module_zip-0.1.1.tm.md crossplatform {index.md crossplatform} punkshell_module_poshinfo(0) doc/files/_module_poshinfo-0.1.0.tm.md alias {index.md alias} kw,filesystem {index.md filesystem} shellspy_module_punk::repl::codethread(0) doc/files/punk/repl/_module_codethread-0.1.0.tm.md punkshell_module_punk::aliascore(0) doc/files/punk/_module_aliascore-0.1.0.tm.md sa,overtype_module_overtype doc/files/_module_overtype-1.6.5.tm.md shell {index.md shell} {assertion alternative to control::assert} doc/files/punk/_module_assertion-0.1.0.tm.md kw,package {index.md package} kw,parsing {index.md parsing} kw,toml {index.md toml} punkshell_module_punk::lib doc/files/punk/_module_lib-0.1.1.tm.md kw,debug {index.md debug} punkshell_module_punk::island doc/files/punk/_module_island-0.1.0.tm.md {punk textblock functions} doc/files/_module_textblock-0.1.2.tm.md sa,punkshell_module_punk::sshrun(0) doc/files/punk/_module_sshrun-0.1.0.tm.md overtype_module_overtype doc/files/_module_overtype-1.6.5.tm.md punkshell_module_punk::blockletter(0) doc/files/punk/_module_blockletter-0.1.0.tm.md punkshell_module_punk::ansi(0) doc/files/punk/_module_ansi-0.1.1.tm.md overtype_module_overtype(0) doc/files/_module_overtype-1.6.5.tm.md sa,punkshell_module_punk::char doc/files/punk/_module_char-0.1.0.tm.md kw,faux {index.md faux} frame {index.md frame} toml {index.md toml} sa,punkshell__project_intro(n) doc/files/project_intro.md shellspy_module_punk::zip doc/files/punk/_module_zip-0.1.0.tm.md kw,unofficial {index.md unofficial} encoding {index.md encoding} punkshell_module_punk::sshrun(0) doc/files/punk/_module_sshrun-0.1.0.tm.md sa,punkshell_module_punk::winlnk(0) doc/files/punk/_module_winlnk-0.1.0.tm.md sa,punkshell_module_punk::flib doc/files/punk/_module_flib-0.1.0.tm.md sa,punkshell_module_punk::args(0) doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::encmime doc/files/punk/_module_encmime-0.1.0.tm.md modpod_module_modpod(0) doc/files/_module_modpod-0.1.2.tm.md punkshell_module_textblock(0) doc/files/_module_textblock-0.1.2.tm.md zip {index.md zip} {Module repl codethread} doc/files/punk/repl/_module_codethread-0.1.0.tm.md kw,BOM {index.md bom} faux {index.md faux} sa,punkshell_module_punk::experiment(0) doc/files/punk/_module_experiment-0.1.0.tm.md {file line-handling utilities} doc/files/punk/_module_fileline-0.1.0.tm.md module {index.md module} sa,punkshell_module_punk::blockletter doc/files/punk/_module_blockletter-0.1.0.tm.md plugin {index.md plugin} unicode {index.md unicode} symlink {index.md symlink} sa,punkshell_module_punk::console(0) doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::winlnk(0) doc/files/punk/_module_winlnk-0.1.0.tm.md kw,capability {index.md capability} sa,modpod_module_modpod doc/files/_module_modpod-0.1.2.tm.md shellspy_module_punk::repl::codethread doc/files/punk/repl/_module_codethread-0.1.0.tm.md kw,crossplatform {index.md crossplatform} punkshell_module_punk::experiment(0) doc/files/punk/_module_experiment-0.1.0.tm.md {punkshell Changes} doc/files/project_changes.md fauxlink_module_fauxlink(0) doc/files/_module_fauxlink-0.1.1.tm.md modpod_module_modpod doc/files/_module_modpod-0.1.2.tm.md punkshell_module_textblock doc/files/_module_textblock-0.1.2.tm.md {Introduction to punkshell} doc/files/project_intro.md punkshell_module_punk::cesu(0) doc/files/punk/_module_cesu-0.1.0.tm.md punkshell_module_punk::assertion(0) doc/files/punk/_module_assertion-0.1.0.tm.md sa,punkshell(n) doc/files/main.md sa,punkshell_module_punk::island(0) doc/files/punk/_module_island-0.1.0.tm.md punkshell::basictelnet doc/files/punk/_module_basictelnet-0.1.0.tm.md {mime encodings related subset of tcllib mime} doc/files/punk/_module_encmime-0.1.0.tm.md punkshell::basictelnet(0) doc/files/punk/_module_basictelnet-0.1.0.tm.md kw,parse {index.md parse} sa,punkshell_module_scriptwrap(0) doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md tomlish_module_tomlish doc/files/_module_tomlish-1.1.1.tm.md punkshell(n) doc/files/main.md kw,string {index.md string} ssh {index.md ssh} kw,file {index.md file} sa,punkshell_module_punk::console doc/files/punk/_module_console-0.1.1.tm.md punkshell_module_punk::winlnk doc/files/punk/_module_winlnk-0.1.0.tm.md sa,punkshell_module_poshinfo doc/files/_module_poshinfo-0.1.0.tm.md punkshell_module_punk::island(0) doc/files/punk/_module_island-0.1.0.tm.md sa,punkshell_module_argparsingtest(0) doc/files/_module_argparsingtest-0.1.0.tm.md punkshell_module_punk::flib(0) doc/files/punk/_module_flib-0.1.0.tm.md {dec commandset - project} doc/files/punk/mix/commandset/_module_project-0.1.0.tm.md sa,punkshell__project_changes doc/files/project_changes.md {kw,prompt theme} {index.md prompt_theme} kw,experimental {index.md experimental} punkshell_module_argparsingtest doc/files/_module_argparsingtest-0.1.0.tm.md sa,punkshell_module_punk::aliascore(0) doc/files/punk/_module_aliascore-0.1.0.tm.md configuration {index.md configuration} file {index.md file} {args parsing} doc/files/punk/_module_args-0.1.0.tm.md punkshell_module_punk::rest doc/files/punk/_module_rest-0.1.0.tm.md encodings {index.md encodings} compatibility {index.md compatibility} {Ansi string functions} doc/files/punk/_module_ansi-0.1.1.tm.md sa,punkshell_module_punk::encmime(0) doc/files/punk/_module_encmime-0.1.0.tm.md sa,shellspy_module_punk::zip(0) doc/files/punk/_module_zip-0.1.0.tm.md kw,assertion {index.md assertion} {scriptwrap polyglot tool} doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md sa,overtype_module_overtype(0) doc/files/_module_overtype-1.6.5.tm.md {overtype text layout - ansi aware} doc/files/_module_overtype-1.6.5.tm.md punkshell_module_punk::path doc/files/punk/_module_path-0.1.0.tm.md kw,repl {index.md repl} punkshell_module_punk::char(0) doc/files/punk/_module_char-0.1.0.tm.md commandset {index.md commandset} kw,text {index.md text} {Tcl procedures to execute tcl scripts in remote hosts} doc/files/punk/_module_sshrun-0.1.0.tm.md punkshell_module_punk::mix::commandset::project doc/files/punk/mix/commandset/_module_project-0.1.0.tm.md sa,tomlish_module_tomlish(0) doc/files/_module_tomlish-1.1.1.tm.md sa,shellspy_module_punk::nav::fs(0) doc/files/punk/nav/_module_fs-0.1.0.tm.md kw,scriptwrap {index.md scriptwrap} {filesystem islands for safe interps} doc/files/punk/_module_island-0.1.0.tm.md shellspy_module_punk::zip(0) doc/files/punk/_module_zip-0.1.0.tm.md kw,protocol {index.md protocol} kw,theme {index.md theme} sa,modpod_module_modpod(0) doc/files/_module_modpod-0.1.2.tm.md repl {index.md repl} shellspy_module_punk::nav::fs(0) doc/files/punk/nav/_module_fs-0.1.0.tm.md text {index.md text} BOM {index.md bom} sa,punkshell_module_punk::aliascore doc/files/punk/_module_aliascore-0.1.0.tm.md kw,POSH {index.md posh} kw,console {index.md console} {character-set and unicode utilities} doc/files/punk/_module_char-0.1.0.tm.md punkshell_module_punk::aliascore doc/files/punk/_module_aliascore-0.1.0.tm.md string {index.md string} \ No newline at end of file diff --git a/src/embedded/md/doc/files/_module_argparsingtest-0.1.0.tm.md b/src/embedded/md/doc/files/_module_argparsingtest-0.1.0.tm.md index ed86cb7e..71e7c31e 100644 --- a/src/embedded/md/doc/files/_module_argparsingtest-0.1.0.tm.md +++ b/src/embedded/md/doc/files/_module_argparsingtest-0.1.0.tm.md @@ -1,8 +1,8 @@ -[//000000001]: # (shellspy\_module\_argparsingtest \- \-) +[//000000001]: # (punkshell\_module\_argparsingtest \- \-) [//000000002]: # (Generated from file '\_module\_argparsingtest\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2024) -[//000000004]: # (shellspy\_module\_argparsingtest\(0\) 0\.1\.0 doc "\-") +[//000000004]: # (punkshell\_module\_argparsingtest\(0\) 0\.1\.0 doc "\-")
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
# NAME -shellspy\_module\_argparsingtest \- Module API +punkshell\_module\_argparsingtest \- Module API # Table Of Contents diff --git a/src/embedded/md/doc/files/_module_fauxlink-0.1.1.tm.md b/src/embedded/md/doc/files/_module_fauxlink-0.1.1.tm.md new file mode 100644 index 00000000..c4a5d84f --- /dev/null +++ b/src/embedded/md/doc/files/_module_fauxlink-0.1.1.tm.md @@ -0,0 +1,168 @@ + +[//000000001]: # (fauxlink\_module\_fauxlink \- fauxlink \.fxlnk) +[//000000002]: # (Generated from file '\_module\_fauxlink\-0\.1\.1\.tm\.man' by tcllib/doctools with format 'markdown') +[//000000003]: # (Copyright © 2024) +[//000000004]: # (fauxlink\_module\_fauxlink\(0\) 0\.1\.1 doc "fauxlink \.fxlnk") + +
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
+ +# NAME + +fauxlink\_module\_fauxlink \- faux link application shortcuts + +# Table Of Contents + + - [Table Of Contents](#toc) + + - [Synopsis](#synopsis) + + - [Description](#section1) + + - [Overview](#section2) + + - [Concepts](#subsection1) + + - [dependencies](#subsection2) + + - [API](#section3) + + - [Namespace fauxlink::class](#subsection3) + + - [Namespace fauxlink](#subsection4) + + - [Namespace fauxlink::lib](#subsection5) + + - [Internal](#section4) + + - [Namespace fauxlink::system](#subsection6) + + - [Keywords](#keywords) + + - [Copyright](#copyright) + +# SYNOPSIS + +package require fauxlink + +# DESCRIPTION + +A cross platform shortcut/symlink alternative\. + +Unapologetically ugly \- but practical in certain circumstances\. + +A solution is required for application\-driven filesystem links that survives +cross platform moves as well as + +archiving and packaging systems\. + +The target is specified in a minimally\-encoded form in the filename itself \- but +still human readable\. + +format of name \#\.fxlnk + +where can be empty \- then the effective nominal name is the tail +of the + +The \+ symbol substitutes for forward\-slashes\. + +Other chars can be encoded using url\-like encoding \- \(but only up to %7E \!\) + +We deliberately treat higher % sequences literally\. + +This means actual uri::urn encoded unicode sequences \(e\.g %E2%99%A5 \[heart\]\) can +remain literal for linking to urls\. + +e\.g if an actual \+ or \# is required in a filename or path segment they can be +encoded as %2B & %23 + +e\.g a link to a file file\#A\.txt in parent dir could be: + +file%23A\.txt\#\.\.\+file%23A\.txt\.fxlnk + +or equivalently \(but obviously affecting sorting\) \#\.\.\+file%23A\.txt\.fxlnk + +The can be unrelated to the actual target + +e\.g datafile\.dat\#\.\.\+file%23A\.txt\.fxlnk + +This system has no filesystem support \- and must be completely application +driven\. + +This can be useful for example in application test packages which may be tarred +or zipped and moved cross platform\. + +The target being fully specified in the name means the file doesn't have to be +read for the target to be determined + +Extensions to behaviour should be added in the file as text data in Toml format, + +with custom data being under a single application\-chosen table name + +The toplevel Toml table \[fauxlink\] is reserved for core extensions to this +system\. + +Aside from the 2 used for delimiting \(\+ \#\) + +certain characters which might normally be allowed in filesystems are required +to be encoded + +e\.g space and tab are required to be %20 %09 + +Others that require encoding are: \* ? \\ / | : ; " < > + +The nul character in raw form, when detected, is always mapped away to the empty +string \- as very few filesystems support it\. + +Control characters and other punctuation is optional to encode\. + +Generally utf\-8 should be used where possible and unicode characters can often +be left unencoded on modern systems\. + +Where encoding of unicode is desired in the nominalname,encodedtarget,tag or +comment portions it can be specified as %UXXXXXXXX + +There must be between 1 and 8 X digits following the %U\. Interpretation of chars +following %U stops at the first non\-hex character\. + +This means %Utest would not get any translation as there were no hex digits so +it would come out as %Utest \+\+ \+\+\+ \+\+\+ \+\+\+ \+\+\+ \+\+\+ \+\+\+ \+\+\+ \+\+\+ \+\+\+ \+\+\+ + +# Overview + +overview of fauxlink + +## Concepts + +\- + +## dependencies + +packages used by fauxlink + + - __Tcl 8\.6\-__ + +# API + +## Namespace fauxlink::class + +class definitions + +## Namespace fauxlink + +## Namespace fauxlink::lib + +# Internal + +## Namespace fauxlink::system + +# KEYWORDS + +[fake](\.\./\.\./index\.md\#fake), [faux](\.\./\.\./index\.md\#faux), +[shortcut](\.\./\.\./index\.md\#shortcut), [symlink](\.\./\.\./index\.md\#symlink), +[toml](\.\./\.\./index\.md\#toml) + +# COPYRIGHT + +Copyright © 2024 diff --git a/src/embedded/md/doc/files/_module_modpod-0.1.0.tm.md b/src/embedded/md/doc/files/_module_modpod-0.1.2.tm.md similarity index 88% rename from src/embedded/md/doc/files/_module_modpod-0.1.0.tm.md rename to src/embedded/md/doc/files/_module_modpod-0.1.2.tm.md index be2592b8..8ce2ade9 100644 --- a/src/embedded/md/doc/files/_module_modpod-0.1.0.tm.md +++ b/src/embedded/md/doc/files/_module_modpod-0.1.2.tm.md @@ -1,8 +1,8 @@ [//000000001]: # (modpod\_module\_modpod \- \-) -[//000000002]: # (Generated from file '\_module\_modpod\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') +[//000000002]: # (Generated from file '\_module\_modpod\-0\.1\.2\.tm\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2024) -[//000000004]: # (modpod\_module\_modpod\(0\) 0\.1\.0 doc "\-") +[//000000004]: # (modpod\_module\_modpod\(0\) 0\.1\.2 doc "\-")
[ Main Table Of Contents | Table Of Contents | [ Main Table Of Contents | Table Of Contents | Keyword Index ]
- -# NAME - -overtype\_module\_overtype \- overtype text layout \- ansi aware - -# Table Of Contents - - - [Table Of Contents](#toc) - - - [Synopsis](#synopsis) - - - [Description](#section1) - - - [Overview](#section2) - - - [Concepts](#subsection1) - - - [dependencies](#subsection2) - - - [API](#section3) - - - [Namespace overtype](#subsection3) - - - [Keywords](#keywords) - - - [Copyright](#copyright) - -# SYNOPSIS - -package require overtype - -[__overtype::renderspace__ *args*](#1) -[__overtype::renderline__ *args*](#2) - -# DESCRIPTION - -\- - -# Overview - -overview of overtype - -## Concepts - -\- - -## dependencies - -packages used by overtype - - - __Tcl 8\.6__ - - - __textutil__ - - - __punk::ansi__ - - \- required to detect, split, strip and calculate lengths of text possibly - containing ansi codes - - - __punk::char__ - - \- box drawing \- and also unicode character width determination for proper - layout of text with double\-column\-width chars - -# API - -## Namespace overtype - -Core API functions for overtype - - - __overtype::renderspace__ *args* - - usage: ?\-transparent \[0|1\]? ?\-overflow \[1|0\]? ?\-ellipsis \[1|0\]? - ?\-ellipsistext \.\.\.? undertext overtext - - - __overtype::renderline__ *args* - - renderline is the core engine for overtype string processing \(frames & - textblocks\), and the raw mode commandline repl for the Tcl Punk Shell - - It is also a central part of an ansi \(micro\) virtual terminal\-emulator of - sorts - - This system does a half decent job at rendering 90's ANSI art to manipulable - colour text blocks that can be joined & framed for layout display within a - unix or windows terminal - - Renderline helps maintain ANSI text styling reset/replay codes so that the - styling of one block doesn't affect another\. - - Calling on the punk::ansi library \- it can coalesce codes to keep the size - down\. - - It is a giant mess of doing exactly what common wisdom says not to do\.\.\. - lots at once\. - - renderline is part of the Unicode and ANSI aware Overtype system which - 'renders' a block of text onto a static underlay - - The underlay is generally expected to be an ordered set of lines or a - rectangular text block analogous to a terminal screen \- but it can also be - ragged in line length, or just blank\. - - The overlay couuld be similar \- in which case it may often be used to - overwrite a column or section of the underlay\. - - The overlay could however be a sequence of ANSI\-laden text that jumps all - over the place\. - - renderline itself only deals with a single line \- or sometimes a single - character\. It is generally called from a loop that does further - terminal\-like or textblock processing\. - - By suppyling the \-info 1 option \- it can return various fields indicating - the state of the render\. - - The main 3 are the result, overflow\_right, and unapplied\. - - Renderline handles cursor movements from either keystrokes or ANSI sequences - but for a full system the aforementioned loop will need to be in place to - manage the set of lines under manipulation\. - -# KEYWORDS - -[ansi](\.\./\.\./index\.md\#ansi), [module](\.\./\.\./index\.md\#module), -[text](\.\./\.\./index\.md\#text) - -# COPYRIGHT - -Copyright © 2024 diff --git a/src/embedded/md/doc/files/_module_overtype-1.6.4.tm.md b/src/embedded/md/doc/files/_module_overtype-1.6.4.tm.md deleted file mode 100644 index 6973cf2e..00000000 --- a/src/embedded/md/doc/files/_module_overtype-1.6.4.tm.md +++ /dev/null @@ -1,139 +0,0 @@ - -[//000000001]: # (overtype\_module\_overtype \- overtype text layout) -[//000000002]: # (Generated from file '\_module\_overtype\-1\.6\.4\.tm\.man' by tcllib/doctools with format 'markdown') -[//000000003]: # (Copyright © 2024) -[//000000004]: # (overtype\_module\_overtype\(0\) 1\.6\.4 doc "overtype text layout") - -
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
- -# NAME - -overtype\_module\_overtype \- overtype text layout \- ansi aware - -# Table Of Contents - - - [Table Of Contents](#toc) - - - [Synopsis](#synopsis) - - - [Description](#section1) - - - [Overview](#section2) - - - [Concepts](#subsection1) - - - [dependencies](#subsection2) - - - [API](#section3) - - - [Namespace overtype](#subsection3) - - - [Keywords](#keywords) - - - [Copyright](#copyright) - -# SYNOPSIS - -package require overtype - -[__overtype::renderspace__ *args*](#1) -[__overtype::renderline__ *args*](#2) - -# DESCRIPTION - -\- - -# Overview - -overview of overtype - -## Concepts - -\- - -## dependencies - -packages used by overtype - - - __Tcl 8\.6__ - - - __textutil__ - - - __punk::ansi__ - - \- required to detect, split, strip and calculate lengths of text possibly - containing ansi codes - - - __punk::char__ - - \- box drawing \- and also unicode character width determination for proper - layout of text with double\-column\-width chars - -# API - -## Namespace overtype - -Core API functions for overtype - - - __overtype::renderspace__ *args* - - usage: ?\-transparent \[0|1\]? ?\-overflow \[1|0\]? ?\-ellipsis \[1|0\]? - ?\-ellipsistext \.\.\.? undertext overtext - - - __overtype::renderline__ *args* - - renderline is the core engine for overtype string processing \(frames & - textblocks\), and the raw mode commandline repl for the Tcl Punk Shell - - It is also a central part of an ansi \(micro\) virtual terminal\-emulator of - sorts - - This system does a half decent job at rendering 90's ANSI art to manipulable - colour text blocks that can be joined & framed for layout display within a - unix or windows terminal - - Renderline helps maintain ANSI text styling reset/replay codes so that the - styling of one block doesn't affect another\. - - Calling on the punk::ansi library \- it can coalesce codes to keep the size - down\. - - It is a giant mess of doing exactly what common wisdom says not to do\.\.\. - lots at once\. - - renderline is part of the Unicode and ANSI aware Overtype system which - 'renders' a block of text onto a static underlay - - The underlay is generally expected to be an ordered set of lines or a - rectangular text block analogous to a terminal screen \- but it can also be - ragged in line length, or just blank\. - - The overlay couuld be similar \- in which case it may often be used to - overwrite a column or section of the underlay\. - - The overlay could however be a sequence of ANSI\-laden text that jumps all - over the place\. - - renderline itself only deals with a single line \- or sometimes a single - character\. It is generally called from a loop that does further - terminal\-like or textblock processing\. - - By suppyling the \-info 1 option \- it can return various fields indicating - the state of the render\. - - The main 3 are the result, overflow\_right, and unapplied\. - - Renderline handles cursor movements from either keystrokes or ANSI sequences - but for a full system the aforementioned loop will need to be in place to - manage the set of lines under manipulation\. - -# KEYWORDS - -[ansi](\.\./\.\./index\.md\#ansi), [module](\.\./\.\./index\.md\#module), -[text](\.\./\.\./index\.md\#text) - -# COPYRIGHT - -Copyright © 2024 diff --git a/src/embedded/md/doc/files/_module_overtype-1.6.5.tm.md b/src/embedded/md/doc/files/_module_overtype-1.6.5.tm.md index 810e80a8..f9da5d34 100644 --- a/src/embedded/md/doc/files/_module_overtype-1.6.5.tm.md +++ b/src/embedded/md/doc/files/_module_overtype-1.6.5.tm.md @@ -79,7 +79,7 @@ Core API functions for overtype - __overtype::renderspace__ *args* - usage: ?\-transparent \[0|1\]? ?\-overflow \[1|0\]? ?\-ellipsis \[1|0\]? + usage: ?\-transparent \[0|1\]? ?\-expand\_right \[1|0\]? ?\-ellipsis \[1|0\]? ?\-ellipsistext \.\.\.? undertext overtext - __overtype::renderline__ *args* diff --git a/src/embedded/md/doc/files/_module_poshinfo-0.1.0.tm.md b/src/embedded/md/doc/files/_module_poshinfo-0.1.0.tm.md index cda04902..678bbd65 100644 --- a/src/embedded/md/doc/files/_module_poshinfo-0.1.0.tm.md +++ b/src/embedded/md/doc/files/_module_poshinfo-0.1.0.tm.md @@ -1,8 +1,8 @@ -[//000000001]: # (shellspy\_module\_poshinfo \- \-) +[//000000001]: # (punkshell\_module\_poshinfo \- POSH\-related prompt tool) [//000000002]: # (Generated from file '\_module\_poshinfo\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2024) -[//000000004]: # (shellspy\_module\_poshinfo\(0\) 0\.1\.0 doc "\-") +[//000000004]: # (punkshell\_module\_poshinfo\(0\) 0\.1\.0 doc "POSH\-related prompt tool")
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
# NAME -shellspy\_module\_poshinfo \- Module API +punkshell\_module\_poshinfo \- poshinfo prompt theme tool # Table Of Contents @@ -72,7 +72,7 @@ packages used by poshinfo ## Namespace poshinfo::class -class definitions if \{ eq ""\} \{ +class definitions ## Namespace poshinfo @@ -84,7 +84,10 @@ class definitions if \{ eq ""\} \{ # KEYWORDS -[module](\.\./\.\./index\.md\#module) +[POSH](\.\./\.\./index\.md\#posh), [console](\.\./\.\./index\.md\#console), +[module](\.\./\.\./index\.md\#module), [prompt](\.\./\.\./index\.md\#prompt), +[prompt theme](\.\./\.\./index\.md\#prompt\_theme), +[terminal](\.\./\.\./index\.md\#terminal), [theme](\.\./\.\./index\.md\#theme) # COPYRIGHT diff --git a/src/embedded/md/doc/files/_module_textblock-0.1.1.tm.md b/src/embedded/md/doc/files/_module_textblock-0.1.1.tm.md index 0de3fc93..60bfff4d 100644 --- a/src/embedded/md/doc/files/_module_textblock-0.1.1.tm.md +++ b/src/embedded/md/doc/files/_module_textblock-0.1.1.tm.md @@ -80,7 +80,7 @@ class definitions - *handler\_classes* - 1. CLASS __interface\_caphandler\.registry__ + 1. CLASS __textblock::class::table__ * class::table __constructor__ *args* diff --git a/src/embedded/md/doc/files/_module_textblock-0.1.2.tm.md b/src/embedded/md/doc/files/_module_textblock-0.1.2.tm.md new file mode 100644 index 00000000..d830d62b --- /dev/null +++ b/src/embedded/md/doc/files/_module_textblock-0.1.2.tm.md @@ -0,0 +1,253 @@ + +[//000000001]: # (punkshell\_module\_textblock \- punk textblock) +[//000000002]: # (Generated from file '\_module\_textblock\-0\.1\.2\.tm\.man' by tcllib/doctools with format 'markdown') +[//000000003]: # (Copyright © 2024) +[//000000004]: # (punkshell\_module\_textblock\(0\) 0\.1\.2 doc "punk textblock") + +
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
+ +# NAME + +punkshell\_module\_textblock \- punk textblock functions + +# Table Of Contents + + - [Table Of Contents](#toc) + + - [Synopsis](#synopsis) + + - [Description](#section1) + + - [Overview](#section2) + + - [Concepts](#subsection1) + + - [dependencies](#subsection2) + + - [API](#section3) + + - [Namespace textblock::class](#subsection3) + + - [Keywords](#keywords) + + - [Copyright](#copyright) + +# SYNOPSIS + +package require textblock + +[class::table __constructor__ *args*](#1) +[class::table __configure__ *args*](#2) +[class::table __printmatrix__ *matrix*](#3) +[class::table __as\_matrix__ *?cmd?*](#4) +[class::table __add\_column__ *args*](#5) +[class::table __column\_count__](#6) +[class::table __configure\_column__ *index\_expression* *args*](#7) +[class::table __header\_count__](#8) +[class::table __header\_height__ *header\_index*](#9) +[class::table __header\_colspans__](#10) +[class::table __configure\_header__](#11) +[class::table __add\_row__ *valuelist* ?__\-minheight__ *int\_minheight*? ?__\-maxheight__ *int\_maxheight*? ?__\-ansibase__ *ansicode*?](#12) +[class::table __configure\_row__ *index\_expression* ?__\-minheight__ *int\_minheight*? ?__\-maxheight__ *int\_maxheight*? ?__\-ansibase__ *ansicode*?](#13) +[class::table __row\_count__](#14) +[class::table __row\_clear__](#15) +[class::table __clear__](#16) +[class::table __get\_column\_cells\_by\_index__ *index\_expression*](#17) +[class::table __get\_column\_values\_by\_index__ *index\_expression*](#18) +[class::table __debug__](#19) +[class::table __column\_width__ *index\_expression*](#20) +[class::table __column\_width__](#21) +[class::table __width__](#22) +[class::table __spangroups__](#23) +[class::table __print__](#24) +[class::table __print\_bodymatrix__](#25) + +# DESCRIPTION + +Ansi\-aware terminal textblock manipulation + +# Overview + +overview of textblock + +## Concepts + +## dependencies + +packages used by textblock + + - __Tcl 8\.6\-__ + + - __punk::args__ + + - __punk::char__ + + - __punk::ansi__ + + - __punk::lib__ + + - __overtype__ + + - __term::ansi::code::macros__ + + - __textutil__ + +# API + +## Namespace textblock::class + +class definitions + + - *handler\_classes* + + 1. CLASS __textblock::class::table__ + + * class::table __constructor__ *args* + + *METHODS* + + TODO \- document the many options + + * class::table __configure__ *args* + + get or set various table\-level properties + + * class::table __printmatrix__ *matrix* + + clear all table rows and print a matrix into the table + + The rowxcolumn structure must match + + * class::table __as\_matrix__ *?cmd?* + + return a struct::matrix command representing the data portion of + the table\. + + * class::table __add\_column__ *args* + + * class::table __column\_count__ + + return the number of columns + + * class::table __configure\_column__ *index\_expression* *args* + + \- undocumented + + * class::table __header\_count__ + + return the number of header rows + + * class::table __header\_height__ *header\_index* + + return the height of a header as the number of content\-lines + + * class::table __header\_colspans__ + + Show the colspans configured for all headers + + * class::table __configure\_header__ + + \- undocumented + + * class::table __add\_row__ *valuelist* ?__\-minheight__ *int\_minheight*? ?__\-maxheight__ *int\_maxheight*? ?__\-ansibase__ *ansicode*? + + * class::table __configure\_row__ *index\_expression* ?__\-minheight__ *int\_minheight*? ?__\-maxheight__ *int\_maxheight*? ?__\-ansibase__ *ansicode*? + + * class::table __row\_count__ + + return the number of data rows in the table\. + + * class::table __row\_clear__ + + Remove all rows without resetting column data\. + + When adding new rows the number of entries will need to match the + existing column count\. + + * class::table __clear__ + + Remove all row and column data\. + + If a subsequent call to add\_row is made it can contain any number + of values\. + + Further calls to add\_row will need to contain the same number of + values + + as the first call unless default values have been set for the + missing columns \(review \- in flux\)\. + + * class::table __get\_column\_cells\_by\_index__ *index\_expression* + + Return a dict with keys 'headers' and 'cells' giving column header + and data values + + * class::table __get\_column\_values\_by\_index__ *index\_expression* + + List the cell values of a column from the data area only \(no header + values\) + + * class::table __debug__ + + display lots of debug information about how the table is + constructed\. + + * class::table __column\_width__ *index\_expression* + + inner width of column ie the available cell\-width without + borders/separators + + * class::table __column\_width__ + + ordered list of column widths \(inner widths\) + + * class::table __width__ + + width of the table including borders and separators + + calculate width based on assumption frame verticals are 1 + screen\-column wide + + \(review \- consider possibility of custom unicode double\-wide + frame?\) + + * class::table __spangroups__ + + return a dict keyed by column\-index showing advanced span + information + + \(debug tool\) + + * class::table __print__ + + Return the table as text suitable for console display + + * class::table __print\_bodymatrix__ + + output the matrix string corresponding to the body data using the + matrix 2string format + + this will be a table without borders,headers,title etc and will + exclude additional ANSI applied due to table, row or column + settings\. + + If the original cell data itself contains ANSI \- the output will + still contain those ansi codes\. + +Already uniform blocks will join faster than textblock::join, and ragged blocks +will join in a ragged manner " Already uniform blocks will join faster than +textblock::join, and ragged blocks will join in a ragged manner " + +# KEYWORDS + +[ansi](\.\./\.\./index\.md\#ansi), [colour](\.\./\.\./index\.md\#colour), +[console](\.\./\.\./index\.md\#console), [frame](\.\./\.\./index\.md\#frame), +[layout](\.\./\.\./index\.md\#layout), [module](\.\./\.\./index\.md\#module), +[table](\.\./\.\./index\.md\#table), [terminal](\.\./\.\./index\.md\#terminal), +[text](\.\./\.\./index\.md\#text) + +# COPYRIGHT + +Copyright © 2024 diff --git a/src/embedded/md/doc/files/_module_tomlish-1.1.1.tm.md b/src/embedded/md/doc/files/_module_tomlish-1.1.1.tm.md index 36792c72..e3fd297d 100644 --- a/src/embedded/md/doc/files/_module_tomlish-1.1.1.tm.md +++ b/src/embedded/md/doc/files/_module_tomlish-1.1.1.tm.md @@ -1,8 +1,8 @@ -[//000000001]: # (tomlish\_module\_tomlish \- \-) +[//000000001]: # (tomlish\_module\_tomlish \- tomlish) [//000000002]: # (Generated from file '\_module\_tomlish\-1\.1\.1\.tm\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2024) -[//000000004]: # (tomlish\_module\_tomlish\(0\) 1\.1\.1 doc "\-") +[//000000004]: # (tomlish\_module\_tomlish\(0\) 1\.1\.1 doc "tomlish")
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
# NAME -tomlish\_module\_tomlish \- Module API +tomlish\_module\_tomlish \- tomlish toml parser # Table Of Contents @@ -28,21 +28,19 @@ tomlish\_module\_tomlish \- Module API - [API](#section3) - - [Namespace tomlish::class](#subsection3) + - [Namespace tomlish](#subsection3) - - [Namespace tomlish](#subsection4) + - [Namespace tomlish::encode](#subsection4) - - [Namespace tomlish::encode](#subsection5) + - [Namespace tomlish::decode](#subsection5) - - [Namespace tomlish::decode](#subsection6) + - [Namespace tomlish::utils](#subsection6) - - [Namespace tomlish::utils](#subsection7) + - [Namespace tomlish::parse](#subsection7) - - [Namespace tomlish::parse](#subsection8) + - [Namespace tomlish::app](#subsection8) - - [Namespace tomlish::app](#subsection9) - - - [Namespace tomlish::lib](#subsection10) + - [Namespace tomlish::lib](#subsection9) - [Keywords](#keywords) @@ -59,7 +57,33 @@ package require tomlish # DESCRIPTION -\- +tomlish is an intermediate representation of toml data in a tree structure +\(tagged lists representing type information\) + +The design goals are for tomlish to be whitespace and comment preserving ie +byte\-for byte preservation during roundtrips from toml to tomlish and back to +toml + +The tomlish representation can then be converted to a Tcl dict structure or to +other formats such as json, + +although these other formats are generally unlikely to retain whitespace or +comments + +A further goal is to allow at least a useful subset of in\-place editing +operations which also preserve whitespace and comments\. + +e\.g leaf key value editing, and table reordering/sorting, key\-renaming at any +level, key insertions/deletions + +The API for editing \(tomldoc object?\) may require explicit setting of type if +accessing an existing key + +e\.g setting a key that already exists and is a different type \(especially if +nested structure such as a table or array\) + +will need a \-type option \(\-force ?\) to force overriding with another type such +as an int\. # Overview @@ -79,27 +103,25 @@ packages used by tomlish # API -## Namespace tomlish::class - -class definitions +## Namespace tomlish -## Namespace tomlish +Core API functions for tomlish - __json\_to\_toml__ *json* -## Namespace tomlish::encode +## Namespace tomlish::encode -## Namespace tomlish::decode +## Namespace tomlish::decode - __toml__ *s* return a Tcl list of tomlish tokens -## Namespace tomlish::utils +## Namespace tomlish::utils -## Namespace tomlish::parse +## Namespace tomlish::parse -## Namespace tomlish::app +## Namespace tomlish::app - app::__decoder__ *args* @@ -123,13 +145,15 @@ class definitions This encoder is intended to be compatible with toml\-test -## Namespace tomlish::lib +## Namespace tomlish::lib Secondary functions that are part of the API # KEYWORDS -[module](\.\./\.\./index\.md\#module) +[configuration](\.\./\.\./index\.md\#configuration), +[module](\.\./\.\./index\.md\#module), [parsing](\.\./\.\./index\.md\#parsing), +[toml](\.\./\.\./index\.md\#toml) # COPYRIGHT diff --git a/src/embedded/md/doc/files/punk/_module_aliascore-0.1.0.tm.md b/src/embedded/md/doc/files/punk/_module_aliascore-0.1.0.tm.md index ac905f57..1d92c9d8 100644 --- a/src/embedded/md/doc/files/punk/_module_aliascore-0.1.0.tm.md +++ b/src/embedded/md/doc/files/punk/_module_aliascore-0.1.0.tm.md @@ -1,8 +1,8 @@ -[//000000001]: # (shellspy\_module\_punk::aliascore \- \-) +[//000000001]: # (punkshell\_module\_punk::aliascore \- \-) [//000000002]: # (Generated from file '\_module\_aliascore\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2024) -[//000000004]: # (shellspy\_module\_punk::aliascore\(0\) 0\.1\.0 doc "\-") +[//000000004]: # (punkshell\_module\_punk::aliascore\(0\) 0\.1\.0 doc "\-")
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
# NAME -shellspy\_module\_punk::aliascore \- Module API +punkshell\_module\_punk::aliascore \- punkshell command aliases # Table Of Contents @@ -76,7 +76,7 @@ Core API functions for punk::aliascore # KEYWORDS -[module](\.\./\.\./\.\./index\.md\#module) +[alias](\.\./\.\./\.\./index\.md\#alias), [module](\.\./\.\./\.\./index\.md\#module) # COPYRIGHT diff --git a/src/embedded/md/doc/files/punk/_module_ansi-0.1.1.tm.md b/src/embedded/md/doc/files/punk/_module_ansi-0.1.1.tm.md index a1e62163..1cfe3a05 100644 --- a/src/embedded/md/doc/files/punk/_module_ansi-0.1.1.tm.md +++ b/src/embedded/md/doc/files/punk/_module_ansi-0.1.1.tm.md @@ -58,45 +58,47 @@ package require punk::ansi [__cursor\_off__](#12) [__move__ *row* *col*](#13) [__move\_emit__ *row* *col* *data* ?row col data\.\.\.?](#14) -[__move\_forward__ *n*](#15) -[__move\_back__ *n*](#16) -[__move\_up__ *n*](#17) -[__move\_down__ *n*](#18) -[__move\_column__ *col*](#19) -[__move\_row__ *row*](#20) -[__cursor\_save__](#21) -[__cursor\_restore__](#22) -[__cursor\_save\_dec__](#23) -[__cursor\_restore\_attributes__](#24) -[__enable\_line\_wrap__](#25) -[__disable\_line\_wrap__](#26) -[__query\_mode\_line\_wrap__](#27) -[__erase\_line__](#28) -[__erase\_sol__](#29) -[__erase\_eol__](#30) -[__scroll\_up__ *n*](#31) -[__scroll\_down__ *n*](#32) -[__insert\_spaces__ *count*](#33) -[__delete\_characters__ *count*](#34) -[__erase\_characters__ *count*](#35) -[__insert\_lines__ *count*](#36) -[__delete\_lines__ *count*](#37) -[__cursor\_pos__](#38) -[__request\_cursor\_information__](#39) -[__request\_tabstops__](#40) -[__titleset__ *windowtitles*](#41) -[__ansistrip__ *text*](#42) -[__ansistripraw__ *text*](#43) -[__is\_sgr\_reset__ *code*](#44) -[__has\_sgr\_leadingreset__ *code*](#45) -[__detect__ *text*](#46) -[__detect\_csi__ *text*](#47) -[__detect\_sgr__ *text*](#48) -[__strip__ *text*](#49) -[__length__ *text*](#50) -[__VIEW__ *string*](#51) -[__COUNT__ *string*](#52) -[__index__ *string* *index*](#53) +[__move\_emitblock__ *row* *col* *textblock*](#15) +[__move\_forward__ *n*](#16) +[__move\_back__ *n*](#17) +[__move\_up__ *n*](#18) +[__move\_down__ *n*](#19) +[__move\_column__ *col*](#20) +[__move\_row__ *row*](#21) +[__cursor\_save__](#22) +[__cursor\_restore__](#23) +[__cursor\_save\_dec__](#24) +[__cursor\_restore\_attributes__](#25) +[__enable\_line\_wrap__](#26) +[__disable\_line\_wrap__](#27) +[__query\_mode\_line\_wrap__](#28) +[__erase\_line__](#29) +[__erase\_sol__](#30) +[__erase\_eol__](#31) +[__scroll\_up__ *n*](#32) +[__scroll\_down__ *n*](#33) +[__insert\_spaces__ *count*](#34) +[__delete\_characters__ *count*](#35) +[__erase\_characters__ *count*](#36) +[__insert\_lines__ *count*](#37) +[__delete\_lines__ *count*](#38) +[__cursor\_pos__](#39) +[__request\_cursor\_information__](#40) +[__request\_tabstops__](#41) +[__titleset__ *windowtitles*](#42) +[__ansistrip__ *text*](#43) +[__ansistrip__ *text*](#44) +[__ansistripraw__ *text*](#45) +[__is\_sgr\_reset__ *code*](#46) +[__has\_sgr\_leadingreset__ *code*](#47) +[__detect__ *text*](#48) +[__detect\_csi__ *text*](#49) +[__detect\_sgr__ *text*](#50) +[__strip__ *text*](#51) +[__length__ *text*](#52) +[__VIEW__ *string*](#53) +[__COUNT__ *string*](#54) +[__index__ *string* *index*](#55) # DESCRIPTION @@ -247,21 +249,23 @@ Core API functions for punk::ansi an intuitive manner compared to other punk::ansi move functions \- so is deliberately omitted\. - - __move\_forward__ *n* + - __move\_emitblock__ *row* *col* *textblock* - - __move\_back__ *n* + - __move\_forward__ *n* - - __move\_up__ *n* + - __move\_back__ *n* - - __move\_down__ *n* + - __move\_up__ *n* - - __move\_column__ *col* + - __move\_down__ *n* - - __move\_row__ *row* + - __move\_column__ *col* + + - __move\_row__ *row* VPA \- Vertical Line Position Absolute - - __cursor\_save__ + - __cursor\_save__ equivalent term::ansi::code::ctrl::sc @@ -270,25 +274,25 @@ Core API functions for punk::ansi On many terminals either will work \- but cursor\_save\_dec is shorter and perhaps more widely supported - - __cursor\_restore__ + - __cursor\_restore__ equivalent term::ansi::code::ctrl::rc ANSI/SCO \- see also cursor\_restore\_dec for the DECRC version - - __cursor\_save\_dec__ + - __cursor\_save\_dec__ equivalent term::ansi::code::ctrl::sca DECSC - - __cursor\_restore\_attributes__ + - __cursor\_restore\_attributes__ equivalent term::ansi::code::ctrl::rca DECRC - - __enable\_line\_wrap__ + - __enable\_line\_wrap__ enable automatic line wrapping when characters entered beyond rightmost column @@ -297,41 +301,41 @@ Core API functions for punk::ansi This is DECAWM \- and is the same sequence output by 'tput smam' - - __disable\_line\_wrap__ + - __disable\_line\_wrap__ disable automatic line wrapping reset DECAWM \- same sequence output by 'tput rmam' tput rmam - - __query\_mode\_line\_wrap__ + - __query\_mode\_line\_wrap__ DECRQM to query line\-wrap state The punk::ansi::query\_mode\_ functions just emit the ansi query sequence\. - - __erase\_line__ + - __erase\_line__ - - __erase\_sol__ + - __erase\_sol__ Erase to start of line, leaving cursor position alone\. - - __erase\_eol__ + - __erase\_eol__ - - __scroll\_up__ *n* + - __scroll\_up__ *n* - - __scroll\_down__ *n* + - __scroll\_down__ *n* - - __insert\_spaces__ *count* + - __insert\_spaces__ *count* - - __delete\_characters__ *count* + - __delete\_characters__ *count* - - __erase\_characters__ *count* + - __erase\_characters__ *count* - - __insert\_lines__ *count* + - __insert\_lines__ *count* - - __delete\_lines__ *count* + - __delete\_lines__ *count* - - __cursor\_pos__ + - __cursor\_pos__ cursor\_pos unlikely to be useful on it's own like this as when written to the terminal, this sequence causes the terminal to emit the row;col sequence @@ -349,7 +353,7 @@ Core API functions for punk::ansi The punk::ansi::cursor\_pos function is used by punk::console::get\_cursor\_pos and punk::console::get\_cursor\_pos\_list - - __request\_cursor\_information__ + - __request\_cursor\_information__ DECRQPSR \(DEC Request Presentation State Report\) for DECCCIR Cursor Information report @@ -359,7 +363,7 @@ Core API functions for punk::ansi A stdin readloop will need to be in place to read this information - - __request\_tabstops__ + - __request\_tabstops__ DECRQPSR \(DEC Request Presentation State Report\) for DECTABSR Tab stop report @@ -367,20 +371,27 @@ Core API functions for punk::ansi When written to the terminal, this sequence causes the terminal to emit tabstop information to stdin - - __titleset__ *windowtitles* + - __titleset__ *windowtitles* Returns the code to set the title of the terminal window to windowtitle This may not work on terminals which have multiple panes/windows - - __ansistrip__ *text* + - __ansistrip__ *text* + + Return a string with ansi codes stripped out + + Alternate graphics chars are replaced with modern unicode equivalents \(e\.g + boxdrawing glyphs\) + + - __ansistrip__ *text* Return a string with ansi codes stripped out Alternate graphics chars are replaced with modern unicode equivalents \(e\.g boxdrawing glyphs\) - - __ansistripraw__ *text* + - __ansistripraw__ *text* Return a string with ansi codes stripped out @@ -395,7 +406,7 @@ API functions for punk::ansi::codetype Utility functions for processing ansi code sequences - - __is\_sgr\_reset__ *code* + - __is\_sgr\_reset__ *code* Return a boolean indicating whether this string has a trailing pure SGR reset @@ -406,7 +417,7 @@ Utility functions for processing ansi code sequences This is primarily intended for testing a single ansi code sequence, but code can be any string where the trailing SGR code is to be tested\. - - __has\_sgr\_leadingreset__ *code* + - __has\_sgr\_leadingreset__ *code* The reset must be the very first item in code to be detected\. Trailing strings/codes ignored\. @@ -419,7 +430,7 @@ based on but not identical to the Perl Text Ansi module: https://github\.com/perlancar/perl\-Text\-ANSI\-Util/blob/master/lib/Text/ANSI/BaseUtil\.pm - - __detect__ *text* + - __detect__ *text* Return a boolean indicating whether Ansi codes were detected in text @@ -432,7 +443,7 @@ https://github\.com/perlancar/perl\-Text\-ANSI\-Util/blob/master/lib/Text/ANSI/B This can cause square brackets that form part of the ansi being backslash escaped \- and the regexp can fail to match - - __detect\_csi__ *text* + - __detect\_csi__ *text* Return a boolean indicating whether an Ansi Control Sequence Introducer \(CSI\) was detected in text @@ -449,7 +460,7 @@ https://github\.com/perlancar/perl\-Text\-ANSI\-Util/blob/master/lib/Text/ANSI/B \(This function is not in perl ta\) - - __detect\_sgr__ *text* + - __detect\_sgr__ *text* Return a boolean indicating whether an ansi Select Graphics Rendition code was detected\. @@ -464,13 +475,13 @@ https://github\.com/perlancar/perl\-Text\-ANSI\-Util/blob/master/lib/Text/ANSI/B \(This function is not in perl ta\) - - __strip__ *text* + - __strip__ *text* Return text stripped of Ansi codes This is a tailcall to punk::ansi::ansistrip - - __length__ *text* + - __length__ *text* Return the character length after stripping ansi codes \- not the printing length @@ -485,7 +496,7 @@ codes is always going to be significantly slower than working with plain strings Just as working with other forms of markup such as HTML \- you simply need to be aware of the tradeoffs and design accordingly\. - - __VIEW__ *string* + - __VIEW__ *string* Return a string with specific ANSI control characters substituted with visual equivalents frome the appropriate unicode C0 and C1 visualisation @@ -502,7 +513,7 @@ aware of the tradeoffs and design accordingly\. As punkshell uses linefeed where possible in preference to crlf even on windows, cr is mapped to \\\\U240D '\\U240D' \- but lf is left as is\. - - __COUNT__ *string* + - __COUNT__ *string* Returns the count of visible graphemes and non\-ansi control characters @@ -524,7 +535,7 @@ aware of the tradeoffs and design accordingly\. To get the width, use punk::ansi::printing\_length instead, which is also ansi aware\. - - __index__ *string* *index* + - __index__ *string* *index* Takes a string that possibly contains ansi codes such as colour,underline etc \(SGR codes\) diff --git a/src/embedded/md/doc/files/punk/_module_assertion-0.1.0.tm.md b/src/embedded/md/doc/files/punk/_module_assertion-0.1.0.tm.md index 4ede4c8f..47c1fbb2 100644 --- a/src/embedded/md/doc/files/punk/_module_assertion-0.1.0.tm.md +++ b/src/embedded/md/doc/files/punk/_module_assertion-0.1.0.tm.md @@ -1,8 +1,8 @@ -[//000000001]: # (shellspy\_module\_punk::assertion \- per\-namespace assertions with ) +[//000000001]: # (punkshell\_module\_punk::assertion \- per\-namespace assertions with ) [//000000002]: # (Generated from file '\_module\_assertion\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2024) -[//000000004]: # (shellspy\_module\_punk::assertion\(0\) 0\.1\.0 doc "per\-namespace assertions with ") +[//000000004]: # (punkshell\_module\_punk::assertion\(0\) 0\.1\.0 doc "per\-namespace assertions with ")
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
# NAME -shellspy\_module\_punk::assertion \- assertion alternative to control::assert +punkshell\_module\_punk::assertion \- assertion alternative to control::assert # Table Of Contents diff --git a/src/embedded/md/doc/files/punk/_module_basictelnet-0.1.0.tm.md b/src/embedded/md/doc/files/punk/_module_basictelnet-0.1.0.tm.md index 51012647..656d0bae 100644 --- a/src/embedded/md/doc/files/punk/_module_basictelnet-0.1.0.tm.md +++ b/src/embedded/md/doc/files/punk/_module_basictelnet-0.1.0.tm.md @@ -1,8 +1,8 @@ -[//000000001]: # (shellspy\_module\_punk::basictelnet \- basic telnet client) +[//000000001]: # (punkshell::basictelnet \- basic telnet client) [//000000002]: # (Generated from file '\_module\_basictelnet\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2024) -[//000000004]: # (shellspy\_module\_punk::basictelnet\(0\) 0\.1\.0 doc "basic telnet client") +[//000000004]: # (punkshell::basictelnet\(0\) 0\.1\.0 doc "basic telnet client")
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
# NAME -shellspy\_module\_punk::basictelnet \- basic telnet client \- DKF/Wiki +punkshell::basictelnet \- basic telnet client \- DKF/Wiki # Table Of Contents @@ -80,7 +80,11 @@ class definitions # KEYWORDS -[module](\.\./\.\./\.\./index\.md\#module) +[console](\.\./\.\./\.\./index\.md\#console), +[module](\.\./\.\./\.\./index\.md\#module), +[protocol](\.\./\.\./\.\./index\.md\#protocol), +[telnet](\.\./\.\./\.\./index\.md\#telnet), +[terminal](\.\./\.\./\.\./index\.md\#terminal) # COPYRIGHT diff --git a/src/embedded/md/doc/files/punk/_module_blockletter-0.1.0.tm.md b/src/embedded/md/doc/files/punk/_module_blockletter-0.1.0.tm.md new file mode 100644 index 00000000..acfa47bf --- /dev/null +++ b/src/embedded/md/doc/files/punk/_module_blockletter-0.1.0.tm.md @@ -0,0 +1,98 @@ + +[//000000001]: # (punkshell\_module\_punk::blockletter \- \-) +[//000000002]: # (Generated from file '\_module\_blockletter\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') +[//000000003]: # (Copyright © 2024) +[//000000004]: # (punkshell\_module\_punk::blockletter\(0\) 0\.1\.0 doc "\-") + +
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
+ +# NAME + +punkshell\_module\_punk::blockletter \- punk::blockletter frame\-based large +lettering test/logo + +# Table Of Contents + + - [Table Of Contents](#toc) + + - [Synopsis](#synopsis) + + - [Description](#section1) + + - [Overview](#section2) + + - [Concepts](#subsection1) + + - [dependencies](#subsection2) + + - [API](#section3) + + - [Namespace punk::blockletter::class](#subsection3) + + - [Namespace punk::blockletter](#subsection4) + + - [Namespace punk::blockletter::lib](#subsection5) + + - [Internal](#section4) + + - [Namespace punk::blockletter::system](#subsection6) + + - [Keywords](#keywords) + + - [Copyright](#copyright) + +# SYNOPSIS + +package require punk::blockletter + +# DESCRIPTION + +This is primarily designed to test large lettering using the block2 frametype +which requires the right font support + +More reasonably sized block\-lettering could be obtained using unicode +half\-blocks instead \- but that doesn't allow the frame outline effect that +block2 gives\. + +Individual blocks have a minimum width of 4 columns and a minimum height of 2 +rows \(smallest element that can be fully framed\) + +# Overview + +overview of punk::blockletter + +## Concepts + +\- + +## dependencies + +packages used by punk::blockletter + + - __Tcl 8\.6__ + + - __textblock__ + +# API + +## Namespace punk::blockletter::class + +class definitions if \{ eq ""\} \{ + +## Namespace punk::blockletter + +## Namespace punk::blockletter::lib + +# Internal + +## Namespace punk::blockletter::system + +# KEYWORDS + +[module](\.\./\.\./\.\./index\.md\#module) + +# COPYRIGHT + +Copyright © 2024 diff --git a/src/embedded/md/doc/files/punk/_module_cesu-0.1.0.tm.md b/src/embedded/md/doc/files/punk/_module_cesu-0.1.0.tm.md new file mode 100644 index 00000000..17432bbe --- /dev/null +++ b/src/embedded/md/doc/files/punk/_module_cesu-0.1.0.tm.md @@ -0,0 +1,93 @@ + +[//000000001]: # (punkshell\_module\_punk::cesu \- CESU experimental) +[//000000002]: # (Generated from file '\_module\_cesu\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') +[//000000003]: # (Copyright © 2024) +[//000000004]: # (punkshell\_module\_punk::cesu\(0\) 0\.1\.0 doc "CESU experimental") + +
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
+ +# NAME + +punkshell\_module\_punk::cesu \- CESU compatibility ehcoding scheme for utf\-16: +8\-Bit \(CESU\-8\) ?? + +# Table Of Contents + + - [Table Of Contents](#toc) + + - [Synopsis](#synopsis) + + - [Description](#section1) + + - [Overview](#section2) + + - [Concepts](#subsection1) + + - [dependencies](#subsection2) + + - [API](#section3) + + - [Namespace punk::cesu](#subsection3) + + - [Namespace punk::cesu::lib](#subsection4) + + - [Internal](#section4) + + - [Namespace punk::cesu::system](#subsection5) + + - [Keywords](#keywords) + + - [Copyright](#copyright) + +# SYNOPSIS + +package require punk::cesu + +# DESCRIPTION + +experimental + +# Overview + +overview of punk::cesu + +## Concepts + +cesu\-8 may be mistaken for utf\-8 if no supplementary chars present\. + +see: https://www\.unicode\.org/reports/tr26/tr26\-4\.html + +Particulary note discouragement of use especially in external interchange\. + +## dependencies + +packages used by punk::cesu + + - __Tcl 8\.6__ + +# API + +## Namespace punk::cesu + +Core API functions for punk::cesu + +## Namespace punk::cesu::lib + +# Internal + +## Namespace punk::cesu::system + +# KEYWORDS + +[cesu](\.\./\.\./\.\./index\.md\#cesu), +[compatibility](\.\./\.\./\.\./index\.md\#compatibility), +[encoding](\.\./\.\./\.\./index\.md\#encoding), +[experimental](\.\./\.\./\.\./index\.md\#experimental), +[module](\.\./\.\./\.\./index\.md\#module), +[unofficial](\.\./\.\./\.\./index\.md\#unofficial) + +# COPYRIGHT + +Copyright © 2024 diff --git a/src/embedded/md/doc/files/punk/_module_experiment-0.1.0.tm.md b/src/embedded/md/doc/files/punk/_module_experiment-0.1.0.tm.md index ef6398e7..15c5cdb7 100644 --- a/src/embedded/md/doc/files/punk/_module_experiment-0.1.0.tm.md +++ b/src/embedded/md/doc/files/punk/_module_experiment-0.1.0.tm.md @@ -1,8 +1,8 @@ -[//000000001]: # (shellspy\_module\_punk::experiment \- \-) +[//000000001]: # (punkshell\_module\_punk::experiment \- \-) [//000000002]: # (Generated from file '\_module\_experiment\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2024) -[//000000004]: # (shellspy\_module\_punk::experiment\(0\) 0\.1\.0 doc "\-") +[//000000004]: # (punkshell\_module\_punk::experiment\(0\) 0\.1\.0 doc "\-")
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
# NAME -shellspy\_module\_punk::experiment \- Module API +punkshell\_module\_punk::experiment \- Module API # Table Of Contents diff --git a/src/embedded/md/doc/files/punk/_module_island-0.1.0.tm.md b/src/embedded/md/doc/files/punk/_module_island-0.1.0.tm.md index 494686d2..7c2051bb 100644 --- a/src/embedded/md/doc/files/punk/_module_island-0.1.0.tm.md +++ b/src/embedded/md/doc/files/punk/_module_island-0.1.0.tm.md @@ -1,8 +1,8 @@ -[//000000001]: # (shellspy\_module\_punk::island \- punk::island for safe interps) +[//000000001]: # (punkshell\_module\_punk::island \- punk::island for safe interps) [//000000002]: # (Generated from file '\_module\_island\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2024) -[//000000004]: # (shellspy\_module\_punk::island\(0\) 0\.1\.0 doc "punk::island for safe interps") +[//000000004]: # (punkshell\_module\_punk::island\(0\) 0\.1\.0 doc "punk::island for safe interps")
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
# NAME -shellspy\_module\_punk::island \- filesystem islands for safe interps +punkshell\_module\_punk::island \- filesystem islands for safe interps # Table Of Contents diff --git a/src/embedded/md/doc/files/punk/_module_lib-0.1.1.tm.md b/src/embedded/md/doc/files/punk/_module_lib-0.1.1.tm.md index a32ab285..e86ea644 100644 --- a/src/embedded/md/doc/files/punk/_module_lib-0.1.1.tm.md +++ b/src/embedded/md/doc/files/punk/_module_lib-0.1.1.tm.md @@ -48,30 +48,31 @@ package require punk::lib [__lpop__ *listvar* ?index?](#2) [__invoke__ *command*](#3) [__lindex\_resolve__ *list* *index*](#4) -[__K__ *x* *y*](#5) -[__is\_utf8\_multibyteprefix__ *str*](#6) -[__is\_utf8\_single__ *1234bytes*](#7) -[__get\_utf8\_leading__ *rawbytes*](#8) -[__hex2dec__ ?option value\.\.\.? *list\_largeHex*](#9) -[__dex2hex__ ?option value\.\.\.? *list\_decimals*](#10) -[__log2__ *x*](#11) -[__logbase__ *b* *x*](#12) -[__factors__ *x*](#13) -[__oddFactors__ *x*](#14) -[__greatestFactorBelow__ *x*](#15) -[__greatestOddFactorBelow__ *x*](#16) -[__greatestOddFactor__ *x*](#17) -[__gcd__ *n* *m*](#18) +[__lindex\_resolve\_basic__ *list* *index*](#5) +[__K__ *x* *y*](#6) +[__is\_utf8\_multibyteprefix__ *str*](#7) +[__is\_utf8\_single__ *1234bytes*](#8) +[__get\_utf8\_leading__ *rawbytes*](#9) +[__hex2dec__ ?option value\.\.\.? *list\_largeHex*](#10) +[__dex2hex__ ?option value\.\.\.? *list\_decimals*](#11) +[__log2__ *x*](#12) +[__logbase__ *b* *x*](#13) +[__factors__ *x*](#14) +[__oddFactors__ *x*](#15) +[__greatestFactorBelow__ *x*](#16) +[__greatestOddFactorBelow__ *x*](#17) +[__greatestOddFactor__ *x*](#18) [__gcd__ *n* *m*](#19) -[__commonDivisors__ *x* *y*](#20) -[__hasglobs__ *str*](#21) -[__trimzero__ *number*](#22) -[__substring\_count__ *str* *substring*](#23) -[__dict\_merge\_ordered__ *defaults* *main*](#24) -[__askuser__ *question*](#25) -[__linesort__ ?sortoption ?val?\.\.\.? *textblock*](#26) -[__list\_as\_lines__ ?\-joinchar char? *linelist*](#27) -[__lines\_as\_list__ ?option value \.\.\.? *text*](#28) +[__gcd__ *n* *m*](#20) +[__commonDivisors__ *x* *y*](#21) +[__hasglobs__ *str*](#22) +[__trimzero__ *number*](#23) +[__substring\_count__ *str* *substring*](#24) +[__dict\_merge\_ordered__ *defaults* *main*](#25) +[__askuser__ *question*](#26) +[__linesort__ ?sortoption ?val?\.\.\.? *textblock*](#27) +[__list\_as\_lines__ ?\-joinchar char? *linelist*](#28) +[__lines\_as\_list__ ?option value \.\.\.? *text*](#29) # DESCRIPTION @@ -158,12 +159,15 @@ Core API functions for punk::lib lindex\_resolve will parse the index expression and return: - a\) \-2 if the supplied index expression is below the lower bound for the + a\) \-3 if the supplied index expression is below the lower bound for the supplied list\. \(< 0\) - b\) \-1 if the supplied index expression is above the upper bound for the + b\) \-2 if the supplied index expression is above the upper bound for the supplied list\. \(> end\) + We don't return \-1 \- as the similar function lindex\_resolve\_basic uses this + to denote out of range at either end of the list + Otherwise it will return an integer corresponding to the position in the list\. @@ -174,7 +178,28 @@ Core API functions for punk::lib Like Tcl list commands \- it will produce an error if the form of the index is not acceptable - - __K__ *x* *y* + For empty lists, end and end\+x indices are considered to be out of bounds on + the upper side \- thus returning \-2 + + - __lindex\_resolve\_basic__ *list* *index* + + Accepts index of the forms accepted by Tcl's list commands\. \(e\.g compound + indices such as 3\+1 end\-2\) + + returns \-1 for out of range at either end, or a valid integer index + + Unlike lindex\_resolve; lindex\_resolve\_basic can't determine if an out of + range index was out of range at the lower or upper bound + + This is only likely to be faster than average over lindex\_resolve for Tcl + which has the builtin lseq command + + The performance advantage is more likely to be present when using compound + indexes such as $x\+1 or end\-1 + + For pure integer indices the performance should be equivalent + + - __K__ *x* *y* The K\-combinator function \- returns the first argument, x and discards y @@ -183,7 +208,7 @@ Core API functions for punk::lib It is used in cases where command\-substitution at the calling\-point performs some desired effect\. - - __is\_utf8\_multibyteprefix__ *str* + - __is\_utf8\_multibyteprefix__ *str* Returns a boolean if str is potentially a prefix for a multibyte utf\-8 character @@ -202,12 +227,12 @@ Core API functions for punk::lib e\.g using: set head \[get\_utf8\_leading $testbytes\] ; set tail \[string range $testbytes \[string length $head\] end\] - - __is\_utf8\_single__ *1234bytes* + - __is\_utf8\_single__ *1234bytes* Tests input of 1,2,3 or 4 bytes and responds with a boolean indicating if it is a valid utf\-8 character \(codepoint\) - - __get\_utf8\_leading__ *rawbytes* + - __get\_utf8\_leading__ *rawbytes* return the leading portion of rawbytes that is a valid utf8 sequence\. @@ -232,7 +257,7 @@ Core API functions for punk::lib The utf\-8 BOM \\xEF\\xBB\\xBF is a valid UTF8 3\-byte sequence and so can also be returned as part of the leading utf8 bytes - - __hex2dec__ ?option value\.\.\.? *list\_largeHex* + - __hex2dec__ ?option value\.\.\.? *list\_largeHex* Convert a list of \(possibly large\) unprefixed hex strings to their decimal values @@ -249,7 +274,7 @@ Core API functions for punk::lib Internal whitespace e\.g "F F" is not permitted \- but a completely empty element "" is allowed and will return 0 - - __dex2hex__ ?option value\.\.\.? *list\_decimals* + - __dex2hex__ ?option value\.\.\.? *list\_decimals* Convert a list of decimal integers to a list of hex values @@ -258,7 +283,7 @@ Core API functions for punk::lib \-case upper|lower determines the case of the hex letters in the output - - __log2__ *x* + - __log2__ *x* log base2 of x @@ -268,7 +293,7 @@ Core API functions for punk::lib \(courtesy of RS [https://wiki\.tcl\-lang\.org/page/Additional\+math\+functions](https://wiki\.tcl\-lang\.org/page/Additional\+math\+functions)\) - - __logbase__ *b* *x* + - __logbase__ *b* *x* log base b of x @@ -279,7 +304,7 @@ Core API functions for punk::lib Use expr's log10\(\) function or tcl::mathfunc::log10 for base 10 - - __factors__ *x* + - __factors__ *x* Return a sorted list of the positive factors of x where x > 0 @@ -315,11 +340,11 @@ Core API functions for punk::lib In other mathematical contexts zero may be considered not to divide anything\. - - __oddFactors__ *x* + - __oddFactors__ *x* Return a list of odd integer factors of x, sorted in ascending order - - __greatestFactorBelow__ *x* + - __greatestFactorBelow__ *x* Return the largest factor of x excluding itself @@ -327,17 +352,17 @@ Core API functions for punk::lib See Tcllib math::numtheory for more extensive implementations - - __greatestOddFactorBelow__ *x* + - __greatestOddFactorBelow__ *x* Return the largest odd integer factor of x excluding x itself - - __greatestOddFactor__ *x* + - __greatestOddFactor__ *x* Return the largest odd integer factor of x For an odd value of x \- this will always return x - - __gcd__ *n* *m* + - __gcd__ *n* *m* Return the greatest common divisor of m and n @@ -349,19 +374,19 @@ Core API functions for punk::lib only if c is a common divisor of a and b - - __gcd__ *n* *m* + - __gcd__ *n* *m* Return the lowest common multiple of m and n Straight from Lars Hellström's math::numtheory library in Tcllib - - __commonDivisors__ *x* *y* + - __commonDivisors__ *x* *y* Return a list of all the common factors of x and y \(equivalent to factors of their gcd\) - - __hasglobs__ *str* + - __hasglobs__ *str* Return a boolean indicating whether str contains any of the glob characters: \* ? \[ \] @@ -369,17 +394,17 @@ Core API functions for punk::lib hasglobs uses append to preserve Tcls internal representation for str \- so it should help avoid shimmering in the few cases where this may matter\. - - __trimzero__ *number* + - __trimzero__ *number* Return number with left\-hand\-side zeros trimmed off \- unless all zero If number is all zero \- a single 0 is returned - - __substring\_count__ *str* *substring* + - __substring\_count__ *str* *substring* Search str and return number of occurrences of substring - - __dict\_merge\_ordered__ *defaults* *main* + - __dict\_merge\_ordered__ *defaults* *main* The standard dict merge accepts multiple dicts with values from dicts to the right \(2nd argument\) taking precedence\. @@ -391,7 +416,7 @@ Core API functions for punk::lib This function merges the two dicts whilst maintaining the key order of main followed by defaults\. - - __askuser__ *question* + - __askuser__ *question* A basic utility to read an answer from stdin @@ -420,7 +445,7 @@ Core API functions for punk::lib puts "Cancelled by user" } - - __linesort__ ?sortoption ?val?\.\.\.? *textblock* + - __linesort__ ?sortoption ?val?\.\.\.? *textblock* Sort lines in textblock @@ -429,7 +454,7 @@ Core API functions for punk::lib options are flags as accepted by lsort ie \-ascii \-command \-decreasing \-dictionary \-index \-indices \-integer \-nocase \-real \-stride \-unique - - __list\_as\_lines__ ?\-joinchar char? *linelist* + - __list\_as\_lines__ ?\-joinchar char? *linelist* This simply joines the elements of the list with \-joinchar @@ -441,7 +466,7 @@ Core API functions for punk::lib lines \- but with more options related to trimming the block and/or each line\. - - __lines\_as\_list__ ?option value \.\.\.? *text* + - __lines\_as\_list__ ?option value \.\.\.? *text* Returns a list of possibly trimmed lines depeding on options diff --git a/src/embedded/md/doc/files/punk/_module_packagepreference-0.1.0.tm.md b/src/embedded/md/doc/files/punk/_module_packagepreference-0.1.0.tm.md index d9920faa..da962dc0 100644 --- a/src/embedded/md/doc/files/punk/_module_packagepreference-0.1.0.tm.md +++ b/src/embedded/md/doc/files/punk/_module_packagepreference-0.1.0.tm.md @@ -1,8 +1,8 @@ -[//000000001]: # (shellspy\_module\_punk::packagepreference \- \-) +[//000000001]: # (punkshell\_module\_punk::packagepreference \- package/module load) [//000000002]: # (Generated from file '\_module\_packagepreference\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2024) -[//000000004]: # (shellspy\_module\_punk::packagepreference\(0\) 0\.1\.0 doc "\-") +[//000000004]: # (punkshell\_module\_punk::packagepreference\(0\) 0\.1\.0 doc "package/module load")
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
# NAME -shellspy\_module\_punk::packagepreference \- Module API +punkshell\_module\_punk::packagepreference \- punkshell package/module loading # Table Of Contents @@ -125,7 +125,7 @@ Secondary functions that are part of the API # KEYWORDS -[module](\.\./\.\./\.\./index\.md\#module) +[module](\.\./\.\./\.\./index\.md\#module), [package](\.\./\.\./\.\./index\.md\#package) # COPYRIGHT diff --git a/src/embedded/md/doc/files/punk/_module_rest-0.1.0.tm.md b/src/embedded/md/doc/files/punk/_module_rest-0.1.0.tm.md new file mode 100644 index 00000000..aedc06c9 --- /dev/null +++ b/src/embedded/md/doc/files/punk/_module_rest-0.1.0.tm.md @@ -0,0 +1,89 @@ + +[//000000001]: # (punkshell\_module\_punk::rest \- experimental rest) +[//000000002]: # (Generated from file '\_module\_rest\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') +[//000000003]: # (Copyright © 2024) +[//000000004]: # (punkshell\_module\_punk::rest\(0\) 0\.1\.0 doc "experimental rest") + +
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
+ +# NAME + +punkshell\_module\_punk::rest \- punk::rest + +# Table Of Contents + + - [Table Of Contents](#toc) + + - [Synopsis](#synopsis) + + - [Description](#section1) + + - [Overview](#section2) + + - [Concepts](#subsection1) + + - [dependencies](#subsection2) + + - [API](#section3) + + - [Namespace punk::rest::class](#subsection3) + + - [Namespace punk::rest](#subsection4) + + - [Namespace punk::rest::lib](#subsection5) + + - [Internal](#section4) + + - [Namespace punk::rest::system](#subsection6) + + - [Keywords](#keywords) + + - [Copyright](#copyright) + +# SYNOPSIS + +package require punk::rest + +# DESCRIPTION + +Experimental \*basic rest as wrapper over http lib \- use tcllib's rest package +for a more complete implementation of a rest client + +# Overview + +overview of punk::rest + +## Concepts + +\- + +## dependencies + +packages used by punk::rest + + - __Tcl 8\.6__ + +# API + +## Namespace punk::rest::class + +class definitions if \{ eq ""\} \{ + +## Namespace punk::rest + +## Namespace punk::rest::lib + +# Internal + +## Namespace punk::rest::system + +# KEYWORDS + +[http](\.\./\.\./\.\./index\.md\#http), [module](\.\./\.\./\.\./index\.md\#module), +[rest](\.\./\.\./\.\./index\.md\#rest) + +# COPYRIGHT + +Copyright © 2024 diff --git a/src/embedded/md/doc/files/punk/_module_sshrun-0.1.0.tm.md b/src/embedded/md/doc/files/punk/_module_sshrun-0.1.0.tm.md index f4c0c143..2b2638a3 100644 --- a/src/embedded/md/doc/files/punk/_module_sshrun-0.1.0.tm.md +++ b/src/embedded/md/doc/files/punk/_module_sshrun-0.1.0.tm.md @@ -1,8 +1,8 @@ -[//000000001]: # (shellspy\_module\_punk::sshrun \- punk::sshrun tclssh clone) +[//000000001]: # (punkshell\_module\_punk::sshrun \- punk::sshrun tclssh clone) [//000000002]: # (Generated from file '\_module\_sshrun\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009) -[//000000004]: # (shellspy\_module\_punk::sshrun\(0\) 0\.1\.0 doc "punk::sshrun tclssh clone") +[//000000004]: # (punkshell\_module\_punk::sshrun\(0\) 0\.1\.0 doc "punk::sshrun tclssh clone")
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
# NAME -shellspy\_module\_punk::sshrun \- Tcl procedures to execute tcl scripts in remote +punkshell\_module\_punk::sshrun \- Tcl procedures to execute tcl scripts in remote hosts # Table Of Contents diff --git a/src/embedded/md/doc/files/punk/_module_trie-0.1.0.tm.md b/src/embedded/md/doc/files/punk/_module_trie-0.1.0.tm.md new file mode 100644 index 00000000..c8242292 --- /dev/null +++ b/src/embedded/md/doc/files/punk/_module_trie-0.1.0.tm.md @@ -0,0 +1,96 @@ + +[//000000001]: # (punkshell\_module\_punk::trie \- punk::trie) +[//000000002]: # (Generated from file '\_module\_trie\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') +[//000000003]: # (Copyright © 2010) +[//000000004]: # (punkshell\_module\_punk::trie\(0\) 0\.1\.0 doc "punk::trie") + +
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
+ +# NAME + +punkshell\_module\_punk::trie \- punk::trie API + +# Table Of Contents + + - [Table Of Contents](#toc) + + - [Synopsis](#synopsis) + + - [Description](#section1) + + - [Overview](#section2) + + - [Concepts](#subsection1) + + - [dependencies](#subsection2) + + - [API](#section3) + + - [Namespace punk::trie](#subsection3) + + - [Namespace punk::trie::lib](#subsection4) + + - [Internal](#section4) + + - [Namespace punk::trie::system](#subsection5) + + - [Keywords](#keywords) + + - [Copyright](#copyright) + +# SYNOPSIS + +package require punk::trie + +[class::trieclass __matches__ *t* *what*](#1) + +# DESCRIPTION + +tcl trie implementation courtesy of CmcC \(tcl wiki\) + +\- + +# Overview + +overview of punk::trie + +## Concepts + +\- + +## dependencies + +packages used by punk::trie + + - __Tcl 8\.6__ + +# API + +## Namespace punk::trie + +Core API functions for punk::trie + + 1. CLASS __trieclass__ + + - class::trieclass __matches__ *t* *what* + + search for longest prefix, return matching prefix, element and suffix + +## Namespace punk::trie::lib + +Secondary functions that are part of the API + +# Internal + +## Namespace punk::trie::system + +# KEYWORDS + +[datastructure](\.\./\.\./\.\./index\.md\#datastructure), +[module](\.\./\.\./\.\./index\.md\#module), [trie](\.\./\.\./\.\./index\.md\#trie) + +# COPYRIGHT + +Copyright © 2010 diff --git a/src/embedded/md/doc/files/punk/_module_uc-0.1.0.tm.md b/src/embedded/md/doc/files/punk/_module_uc-0.1.0.tm.md index 6212ea67..fab7a726 100644 --- a/src/embedded/md/doc/files/punk/_module_uc-0.1.0.tm.md +++ b/src/embedded/md/doc/files/punk/_module_uc-0.1.0.tm.md @@ -1,8 +1,8 @@ -[//000000001]: # (shellspy\_module\_punk::uc \- \-) +[//000000001]: # (punkshell\_module\_punk::uc \- \-) [//000000002]: # (Generated from file '\_module\_uc\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2024) -[//000000004]: # (shellspy\_module\_punk::uc\(0\) 0\.1\.0 doc "\-") +[//000000004]: # (punkshell\_module\_punk::uc\(0\) 0\.1\.0 doc "\-")
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
# NAME -shellspy\_module\_punk::uc \- Module API +punkshell\_module\_punk::uc \- Module API # Table Of Contents @@ -80,7 +80,10 @@ class definitions # KEYWORDS -[module](\.\./\.\./\.\./index\.md\#module) +[module](\.\./\.\./\.\./index\.md\#module), +[unicode](\.\./\.\./\.\./index\.md\#unicode), +[unofficial](\.\./\.\./\.\./index\.md\#unofficial), +[wcswidth](\.\./\.\./\.\./index\.md\#wcswidth) # COPYRIGHT diff --git a/src/embedded/md/doc/files/punk/_module_winlnk-0.1.0.tm.md b/src/embedded/md/doc/files/punk/_module_winlnk-0.1.0.tm.md new file mode 100644 index 00000000..7dab0146 --- /dev/null +++ b/src/embedded/md/doc/files/punk/_module_winlnk-0.1.0.tm.md @@ -0,0 +1,116 @@ + +[//000000001]: # (punkshell\_module\_punk::winlnk \- punk::winlnk) +[//000000002]: # (Generated from file '\_module\_winlnk\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') +[//000000003]: # (Copyright © 2024) +[//000000004]: # (punkshell\_module\_punk::winlnk\(0\) 0\.1\.0 doc "punk::winlnk") + +
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
+ +# NAME + +punkshell\_module\_punk::winlnk \- windows shortcut \.lnk library + +# Table Of Contents + + - [Table Of Contents](#toc) + + - [Synopsis](#synopsis) + + - [Description](#section1) + + - [Overview](#section2) + + - [Concepts](#subsection1) + + - [dependencies](#subsection2) + + - [API](#section3) + + - [Namespace punk::winlnk::class](#subsection3) + + - [Namespace punk::winlnk](#subsection4) + + - [Namespace punk::winlnk::lib](#subsection5) + + - [Internal](#section4) + + - [Namespace punk::winlnk::system](#subsection6) + + - [Keywords](#keywords) + + - [Copyright](#copyright) + +# SYNOPSIS + +package require punk::winlnk + +[__file\_check\_header__ *path*](#1) +[__file\_get\_info__ *path*](#2) + +# DESCRIPTION + +Tools for reading windows shortcuts \(\.lnk files\) on any platform + +# Overview + +overview of punk::winlnk + +## Concepts + +Windows shortcuts are a binary format file with a \.lnk extension + +Shell Link \(\.LNK\) Binary File Format is documented in \[MS\_SHLLINK\]\.pdf published +by Microsoft\. + +Revision 8\.0 published 2024\-04\-23 + +## dependencies + +packages used by punk::winlnk + + - __Tcl 8\.6__ + +# API + +## Namespace punk::winlnk::class + +class definitions if \{ eq ""\} \{ + +## Namespace punk::winlnk + + - __file\_check\_header__ *path* + + Return 0|1 + + Determines if the \.lnk file specified in path has a valid header for a + windows shortcut + + - __file\_get\_info__ *path* + + Return a dict of info obtained by parsing the binary data in a windows \.lnk + file + + If the \.lnk header check fails, then the \.lnk file probably isn't really a + shortcut file and the dictionary will contain an 'error' key + +## Namespace punk::winlnk::lib + +Secondary functions that are part of the API + +# Internal + +## Namespace punk::winlnk::system + +# KEYWORDS + +[crossplatform](\.\./\.\./\.\./index\.md\#crossplatform), +[lnk](\.\./\.\./\.\./index\.md\#lnk), [module](\.\./\.\./\.\./index\.md\#module), +[parse](\.\./\.\./\.\./index\.md\#parse), +[shortcut](\.\./\.\./\.\./index\.md\#shortcut), +[windows](\.\./\.\./\.\./index\.md\#windows) + +# COPYRIGHT + +Copyright © 2024 diff --git a/src/embedded/md/doc/files/punk/_module_zip-0.1.1.tm.md b/src/embedded/md/doc/files/punk/_module_zip-0.1.1.tm.md new file mode 100644 index 00000000..04410b09 --- /dev/null +++ b/src/embedded/md/doc/files/punk/_module_zip-0.1.1.tm.md @@ -0,0 +1,125 @@ + +[//000000001]: # (punkshell\_module\_punk::zip \- \-) +[//000000002]: # (Generated from file '\_module\_zip\-0\.1\.1\.tm\.man' by tcllib/doctools with format 'markdown') +[//000000003]: # (Copyright © 2024) +[//000000004]: # (punkshell\_module\_punk::zip\(0\) 0\.1\.1 doc "\-") + +
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
+ +# NAME + +punkshell\_module\_punk::zip \- Module API + +# Table Of Contents + + - [Table Of Contents](#toc) + + - [Synopsis](#synopsis) + + - [Description](#section1) + + - [Overview](#section2) + + - [Concepts](#subsection1) + + - [dependencies](#subsection2) + + - [API](#section3) + + - [Namespace punk::zip](#subsection3) + + - [Namespace punk::zip::lib](#subsection4) + + - [Keywords](#keywords) + + - [Copyright](#copyright) + +# SYNOPSIS + +package require punk::zip + +[__Timet\_to\_dos__ *time\_t*](#1) +[__walk__ *?options?* *base*](#2) +[__Addentry__ *zipchan* *base* *path* *?comment?*](#3) +[__mkzip__ ?__\-offsettype__ *offsettype*? ?__\-return__ *returntype*? ?__\-zipkit__ *0|1*? ?__\-runtime__ *preamble\_filename*? ?__\-comment__ *zipfilecomment*? ?__\-directory__ *dir\_to\_zip*? ?__\-base__ *archive\_root*? ?__\-exclude__ *globlist*? *zipfilename* *?glob\.\.\.?*](#4) + +# DESCRIPTION + +\- + +# Overview + +overview of punk::zip + +## Concepts + +\- + +## dependencies + +packages used by punk::zip + + - __Tcl 8\.6__ + + - __punk::args__ + +# API + +## Namespace punk::zip + +Core API functions for punk::zip + + - __Timet\_to\_dos__ *time\_t* + + convert a unix timestamp into a DOS timestamp for ZIP times\. + + DOS timestamps are 32 bits split into bit regions as follows: + 24 16 8 0 + +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ + |Y|Y|Y|Y|Y|Y|Y|m| |m|m|m|d|d|d|d|d| |h|h|h|h|h|m|m|m| |m|m|m|s|s|s|s|s| + +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ + + - __walk__ *?options?* *base* + + Walk a directory tree rooted at base + + the \-excludes list can be a set of glob expressions to match against files + and avoid + + e\.g + + punk::zip::walk -exclude {CVS/* *~.#*} library + + - __Addentry__ *zipchan* *base* *path* *?comment?* + + Add a single file to a zip archive + + The zipchan channel should already be open and binary\. + + You can provide a \-comment for the file\. + + The return value is the central directory record that will need to be used + when finalizing the zip archive\. + + - __mkzip__ ?__\-offsettype__ *offsettype*? ?__\-return__ *returntype*? ?__\-zipkit__ *0|1*? ?__\-runtime__ *preamble\_filename*? ?__\-comment__ *zipfilecomment*? ?__\-directory__ *dir\_to\_zip*? ?__\-base__ *archive\_root*? ?__\-exclude__ *globlist*? *zipfilename* *?glob\.\.\.?* + + Create a zip archive in 'zipfilename' + + If a file already exists, an error will be raised\. + + Call 'punk::zip::mkzip' with no arguments for usage display\. + +## Namespace punk::zip::lib + +Secondary functions that are part of the API + +# KEYWORDS + +[fileformat](\.\./\.\./\.\./index\.md\#fileformat), +[module](\.\./\.\./\.\./index\.md\#module), [zip](\.\./\.\./\.\./index\.md\#zip) + +# COPYRIGHT + +Copyright © 2024 diff --git a/src/embedded/md/doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md b/src/embedded/md/doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md new file mode 100644 index 00000000..ff1b0c50 --- /dev/null +++ b/src/embedded/md/doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.md @@ -0,0 +1,108 @@ + +[//000000001]: # (punkshell\_module\_scriptwrap \- scriptwrap tool) +[//000000002]: # (Generated from file '\_module\_scriptwrap\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') +[//000000003]: # (Copyright © 2024) +[//000000004]: # (punkshell\_module\_scriptwrap\(0\) 0\.1\.0 doc "scriptwrap tool") + +
[ Main Table Of Contents | +Table Of Contents | Keyword Index ]
+ +# NAME + +punkshell\_module\_scriptwrap \- scriptwrap polyglot tool + +# Table Of Contents + + - [Table Of Contents](#toc) + + - [Synopsis](#synopsis) + + - [Description](#section1) + + - [Overview](#section2) + + - [Concepts](#subsection1) + + - [dependencies](#subsection2) + + - [API](#section3) + + - [Namespace punk::mix::commandset::scriptwrap](#subsection3) + + - [Namespace punk::mix::commandset::scriptwrap::lib](#subsection4) + + - [Namespace + punk::mix::commandset::scriptwrap::batchlib](#subsection5) + + - [Keywords](#keywords) + + - [Copyright](#copyright) + +# SYNOPSIS + +package require punk::mix::commandset::scriptwrap + +[__get\_wrapper\_folders__ *args*](#1) + +# DESCRIPTION + +\- + +# Overview + +overview of scriptwrap + +## Concepts + +\- + +## dependencies + +packages used by poshinfo + + - __Tcl 8\.6__ + + - __punk::lib__ + + - __punk::args__ + + - __punk::mix__ + + - __punk::base__ + + - __punk::fileline__ + +# API + +## Namespace punk::mix::commandset::scriptwrap + +Core API functions for punk::mix::commandset::scriptwrap + +## Namespace punk::mix::commandset::scriptwrap::lib + + - __get\_wrapper\_folders__ *args* + + Return list of dicts representing wrapper folders in the project\. keys: + basefolder sourceinfo + + Arguments: + + * string *args* + + name\-value pairs \-scriptpath + +## Namespace punk::mix::commandset::scriptwrap::batchlib + +Utility funcions for processing windows \.bat files + +# KEYWORDS + +[commandset](\.\./\.\./\.\./\.\./\.\./index\.md\#commandset), +[launcher](\.\./\.\./\.\./\.\./\.\./index\.md\#launcher), +[module](\.\./\.\./\.\./\.\./\.\./index\.md\#module), +[scriptwrap](\.\./\.\./\.\./\.\./\.\./index\.md\#scriptwrap) + +# COPYRIGHT + +Copyright © 2024 diff --git a/src/embedded/md/doc/files/punk/nav/_module_fs-0.1.0.tm.md b/src/embedded/md/doc/files/punk/nav/_module_fs-0.1.0.tm.md index 0e967e4d..9eb27c5b 100644 --- a/src/embedded/md/doc/files/punk/nav/_module_fs-0.1.0.tm.md +++ b/src/embedded/md/doc/files/punk/nav/_module_fs-0.1.0.tm.md @@ -1,8 +1,8 @@ -[//000000001]: # (shellspy\_module\_punk::nav::fs \- \-) +[//000000001]: # (shellspy\_module\_punk::nav::fs \- fs nav) [//000000002]: # (Generated from file '\_module\_fs\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2024) -[//000000004]: # (shellspy\_module\_punk::nav::fs\(0\) 0\.1\.0 doc "\-") +[//000000004]: # (shellspy\_module\_punk::nav::fs\(0\) 0\.1\.0 doc "fs nav")
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
# NAME -shellspy\_module\_punk::nav::fs \- Module API +shellspy\_module\_punk::nav::fs \- punk::nav::fs console filesystem navigation # Table Of Contents @@ -90,7 +90,9 @@ class definitions if \{ eq ""\} \{ # KEYWORDS -[module](\.\./\.\./\.\./\.\./index\.md\#module) +[filesystem](\.\./\.\./\.\./\.\./index\.md\#filesystem), +[module](\.\./\.\./\.\./\.\./index\.md\#module), +[terminal](\.\./\.\./\.\./\.\./index\.md\#terminal) # COPYRIGHT diff --git a/src/embedded/md/doc/files/punk/repl/_module_codethread-0.1.0.tm.md b/src/embedded/md/doc/files/punk/repl/_module_codethread-0.1.0.tm.md index 22f412be..dab9aa2d 100644 --- a/src/embedded/md/doc/files/punk/repl/_module_codethread-0.1.0.tm.md +++ b/src/embedded/md/doc/files/punk/repl/_module_codethread-0.1.0.tm.md @@ -1,8 +1,8 @@ -[//000000001]: # (shellspy\_module\_punk::repl::codethread \- \-) +[//000000001]: # (shellspy\_module\_punk::repl::codethread \- codethread for repl \- root interpreter) [//000000002]: # (Generated from file '\_module\_codethread\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2024) -[//000000004]: # (shellspy\_module\_punk::repl::codethread\(0\) 0\.1\.0 doc "\-") +[//000000004]: # (shellspy\_module\_punk::repl::codethread\(0\) 0\.1\.0 doc "codethread for repl \- root interpreter")
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
# NAME -shellspy\_module\_punk::repl::codethread \- Module API +shellspy\_module\_punk::repl::codethread \- Module repl codethread # Table Of Contents @@ -48,7 +48,7 @@ package require punk::repl::codethread # DESCRIPTION -\- +This is part of the infrastructure required for the punk::repl to operate # Overview @@ -80,7 +80,7 @@ class definitions if \{ eq ""\} \{ # KEYWORDS -[module](\.\./\.\./\.\./\.\./index\.md\#module) +[module](\.\./\.\./\.\./\.\./index\.md\#module), [repl](\.\./\.\./\.\./\.\./index\.md\#repl) # COPYRIGHT diff --git a/src/embedded/md/doc/toc.md b/src/embedded/md/doc/toc.md index 7fb2eddf..da725603 100644 --- a/src/embedded/md/doc/toc.md +++ b/src/embedded/md/doc/toc.md @@ -3,68 +3,82 @@ # Table Of Contents \-\- doc - - [modpod\_module\_modpod](doc/files/\_module\_modpod\-0\.1\.0\.tm\.md) Module API + - [fauxlink\_module\_fauxlink](doc/files/\_module\_fauxlink\-0\.1\.1\.tm\.md) faux link application shortcuts - - [overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.3\.tm\.md) overtype text layout \- ansi aware - - - [overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.4\.tm\.md) overtype text layout \- ansi aware + - [modpod\_module\_modpod](doc/files/\_module\_modpod\-0\.1\.2\.tm\.md) Module API - [overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.5\.tm\.md) overtype text layout \- ansi aware - [punkshell](doc/files/main\.md) punkshell \- Core + - [punkshell::basictelnet](doc/files/punk/\_module\_basictelnet\-0\.1\.0\.tm\.md) basic telnet client \- DKF/Wiki + - [punkshell\_\_project\_changes](doc/files/project\_changes\.md) punkshell Changes - [punkshell\_\_project\_intro](doc/files/project\_intro\.md) Introduction to punkshell + - [punkshell\_module\_argparsingtest](doc/files/\_module\_argparsingtest\-0\.1\.0\.tm\.md) Module API + + - [punkshell\_module\_poshinfo](doc/files/\_module\_poshinfo\-0\.1\.0\.tm\.md) poshinfo prompt theme tool + + - [punkshell\_module\_punk::aliascore](doc/files/punk/\_module\_aliascore\-0\.1\.0\.tm\.md) punkshell command aliases + - [punkshell\_module\_punk::ansi](doc/files/punk/\_module\_ansi\-0\.1\.1\.tm\.md) Ansi string functions - [punkshell\_module\_punk::args](doc/files/punk/\_module\_args\-0\.1\.0\.tm\.md) args parsing + - [punkshell\_module\_punk::assertion](doc/files/punk/\_module\_assertion\-0\.1\.0\.tm\.md) assertion alternative to control::assert + + - [punkshell\_module\_punk::blockletter](doc/files/punk/\_module\_blockletter\-0\.1\.0\.tm\.md) punk::blockletter frame\-based large lettering test/logo + - [punkshell\_module\_punk::cap](doc/files/punk/\_module\_cap\-0\.1\.0\.tm\.md) capability provider and handler plugin system + - [punkshell\_module\_punk::cesu](doc/files/punk/\_module\_cesu\-0\.1\.0\.tm\.md) CESU compatibility ehcoding scheme for utf\-16: 8\-Bit \(CESU\-8\) ?? + - [punkshell\_module\_punk::char](doc/files/punk/\_module\_char\-0\.1\.0\.tm\.md) character\-set and unicode utilities - [punkshell\_module\_punk::console](doc/files/punk/\_module\_console\-0\.1\.1\.tm\.md) punk console - [punkshell\_module\_punk::encmime](doc/files/punk/\_module\_encmime\-0\.1\.0\.tm\.md) mime encodings related subset of tcllib mime + - [punkshell\_module\_punk::experiment](doc/files/punk/\_module\_experiment\-0\.1\.0\.tm\.md) Module API + - [punkshell\_module\_punk::fileline](doc/files/punk/\_module\_fileline\-0\.1\.0\.tm\.md) file line\-handling utilities - [punkshell\_module\_punk::flib](doc/files/punk/\_module\_flib\-0\.1\.0\.tm\.md) flib experimental + - [punkshell\_module\_punk::island](doc/files/punk/\_module\_island\-0\.1\.0\.tm\.md) filesystem islands for safe interps + - [punkshell\_module\_punk::lib](doc/files/punk/\_module\_lib\-0\.1\.1\.tm\.md) punk general utility functions - [punkshell\_module\_punk::mix::commandset::project](doc/files/punk/mix/commandset/\_module\_project\-0\.1\.0\.tm\.md) dec commandset \- project - - [punkshell\_module\_punk::path](doc/files/punk/\_module\_path\-0\.1\.0\.tm\.md) Filesystem path utilities + - [punkshell\_module\_punk::packagepreference](doc/files/punk/\_module\_packagepreference\-0\.1\.0\.tm\.md) punkshell package/module loading - - [punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.1\.tm\.md) punk textblock functions - - - [shellspy\_module\_argparsingtest](doc/files/\_module\_argparsingtest\-0\.1\.0\.tm\.md) Module API + - [punkshell\_module\_punk::path](doc/files/punk/\_module\_path\-0\.1\.0\.tm\.md) Filesystem path utilities - - [shellspy\_module\_poshinfo](doc/files/\_module\_poshinfo\-0\.1\.0\.tm\.md) Module API + - [punkshell\_module\_punk::rest](doc/files/punk/\_module\_rest\-0\.1\.0\.tm\.md) punk::rest - - [shellspy\_module\_punk::aliascore](doc/files/punk/\_module\_aliascore\-0\.1\.0\.tm\.md) Module API + - [punkshell\_module\_punk::sshrun](doc/files/punk/\_module\_sshrun\-0\.1\.0\.tm\.md) Tcl procedures to execute tcl scripts in remote hosts - - [shellspy\_module\_punk::assertion](doc/files/punk/\_module\_assertion\-0\.1\.0\.tm\.md) assertion alternative to control::assert + - [punkshell\_module\_punk::trie](doc/files/punk/\_module\_trie\-0\.1\.0\.tm\.md) punk::trie API - - [shellspy\_module\_punk::basictelnet](doc/files/punk/\_module\_basictelnet\-0\.1\.0\.tm\.md) basic telnet client \- DKF/Wiki + - [punkshell\_module\_punk::uc](doc/files/punk/\_module\_uc\-0\.1\.0\.tm\.md) Module API - - [shellspy\_module\_punk::experiment](doc/files/punk/\_module\_experiment\-0\.1\.0\.tm\.md) Module API + - [punkshell\_module\_punk::winlnk](doc/files/punk/\_module\_winlnk\-0\.1\.0\.tm\.md) windows shortcut \.lnk library - - [shellspy\_module\_punk::island](doc/files/punk/\_module\_island\-0\.1\.0\.tm\.md) filesystem islands for safe interps + - [punkshell\_module\_punk::zip](doc/files/punk/\_module\_zip\-0\.1\.1\.tm\.md) Module API - - [shellspy\_module\_punk::nav::fs](doc/files/punk/nav/\_module\_fs\-0\.1\.0\.tm\.md) Module API + - [punkshell\_module\_scriptwrap](doc/files/punk/mix/commandset/\_module\_scriptwrap\-0\.1\.0\.tm\.md) scriptwrap polyglot tool - - [shellspy\_module\_punk::packagepreference](doc/files/punk/\_module\_packagepreference\-0\.1\.0\.tm\.md) Module API + - [punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.1\.tm\.md) punk textblock functions - - [shellspy\_module\_punk::repl::codethread](doc/files/punk/repl/\_module\_codethread\-0\.1\.0\.tm\.md) Module API + - [punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.2\.tm\.md) punk textblock functions - - [shellspy\_module\_punk::sshrun](doc/files/punk/\_module\_sshrun\-0\.1\.0\.tm\.md) Tcl procedures to execute tcl scripts in remote hosts + - [shellspy\_module\_punk::nav::fs](doc/files/punk/nav/\_module\_fs\-0\.1\.0\.tm\.md) punk::nav::fs console filesystem navigation - - [shellspy\_module\_punk::uc](doc/files/punk/\_module\_uc\-0\.1\.0\.tm\.md) Module API + - [shellspy\_module\_punk::repl::codethread](doc/files/punk/repl/\_module\_codethread\-0\.1\.0\.tm\.md) Module repl codethread - [shellspy\_module\_punk::zip](doc/files/punk/\_module\_zip\-0\.1\.0\.tm\.md) Module API - - [tomlish\_module\_tomlish](doc/files/\_module\_tomlish\-1\.1\.1\.tm\.md) Module API + - [tomlish\_module\_tomlish](doc/files/\_module\_tomlish\-1\.1\.1\.tm\.md) tomlish toml parser diff --git a/src/embedded/md/index.md b/src/embedded/md/index.md index d0a6a2c7..2e584619 100644 --- a/src/embedded/md/index.md +++ b/src/embedded/md/index.md @@ -5,7 +5,7 @@ ---- -[A](#cA) · [B](#cB) · [C](#cC) · [D](#cD) · [E](#cE) · [F](#cF) · [I](#cI) · [L](#cL) · [M](#cM) · [P](#cP) · [R](#cR) · [S](#cS) · [T](#cT) · [U](#cU) +[A](#cA) · [B](#cB) · [C](#cC) · [D](#cD) · [E](#cE) · [F](#cF) · [H](#cH) · [I](#cI) · [L](#cL) · [M](#cM) · [P](#cP) · [R](#cR) · [S](#cS) · [T](#cT) · [U](#cU) · [W](#cW) · [Z](#cZ) ---- @@ -13,11 +13,12 @@ ||| |---|---| -|ansi|[overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.3\.tm\.md) · [overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.4\.tm\.md) · [overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.5\.tm\.md) · [punkshell\_module\_punk::ansi](doc/files/punk/\_module\_ansi\-0\.1\.1\.tm\.md)| +|alias|[punkshell\_module\_punk::aliascore](doc/files/punk/\_module\_aliascore\-0\.1\.0\.tm\.md)| +|ansi|[overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.5\.tm\.md) · [punkshell\_module\_punk::ansi](doc/files/punk/\_module\_ansi\-0\.1\.1\.tm\.md) · [punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.2\.tm\.md)| |args|[punkshell\_module\_punk::args](doc/files/punk/\_module\_args\-0\.1\.0\.tm\.md)| |arguments|[punkshell\_module\_punk::args](doc/files/punk/\_module\_args\-0\.1\.0\.tm\.md)| -|assert|[shellspy\_module\_punk::assertion](doc/files/punk/\_module\_assertion\-0\.1\.0\.tm\.md)| -|assertion|[shellspy\_module\_punk::assertion](doc/files/punk/\_module\_assertion\-0\.1\.0\.tm\.md)| +|assert|[punkshell\_module\_punk::assertion](doc/files/punk/\_module\_assertion\-0\.1\.0\.tm\.md)| +|assertion|[punkshell\_module\_punk::assertion](doc/files/punk/\_module\_assertion\-0\.1\.0\.tm\.md)| #### Keywords: B @@ -32,63 +33,90 @@ ||| |---|---| |capability|[punkshell\_module\_punk::cap](doc/files/punk/\_module\_cap\-0\.1\.0\.tm\.md)| +|cesu|[punkshell\_module\_punk::cesu](doc/files/punk/\_module\_cesu\-0\.1\.0\.tm\.md)| |changelog|[punkshell\_\_project\_changes](doc/files/project\_changes\.md)| -|console|[punkshell\_module\_punk::ansi](doc/files/punk/\_module\_ansi\-0\.1\.1\.tm\.md) · [punkshell\_module\_punk::console](doc/files/punk/\_module\_console\-0\.1\.1\.tm\.md)| +|colour|[punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.2\.tm\.md)| +|commandset|[punkshell\_module\_scriptwrap](doc/files/punk/mix/commandset/\_module\_scriptwrap\-0\.1\.0\.tm\.md)| +|compatibility|[punkshell\_module\_punk::cesu](doc/files/punk/\_module\_cesu\-0\.1\.0\.tm\.md)| +|configuration|[tomlish\_module\_tomlish](doc/files/\_module\_tomlish\-1\.1\.1\.tm\.md)| +|console|[punkshell::basictelnet](doc/files/punk/\_module\_basictelnet\-0\.1\.0\.tm\.md) · [punkshell\_module\_poshinfo](doc/files/\_module\_poshinfo\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::ansi](doc/files/punk/\_module\_ansi\-0\.1\.1\.tm\.md) · [punkshell\_module\_punk::console](doc/files/punk/\_module\_console\-0\.1\.1\.tm\.md) · [punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.2\.tm\.md)| +|crossplatform|[punkshell\_module\_punk::winlnk](doc/files/punk/\_module\_winlnk\-0\.1\.0\.tm\.md)| #### Keywords: D ||| |---|---| -|debug|[shellspy\_module\_punk::assertion](doc/files/punk/\_module\_assertion\-0\.1\.0\.tm\.md)| +|datastructure|[punkshell\_module\_punk::trie](doc/files/punk/\_module\_trie\-0\.1\.0\.tm\.md)| +|debug|[punkshell\_module\_punk::assertion](doc/files/punk/\_module\_assertion\-0\.1\.0\.tm\.md)| #### Keywords: E ||| |---|---| -|encoding|[punkshell\_module\_punk::fileline](doc/files/punk/\_module\_fileline\-0\.1\.0\.tm\.md)| +|encoding|[punkshell\_module\_punk::cesu](doc/files/punk/\_module\_cesu\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::fileline](doc/files/punk/\_module\_fileline\-0\.1\.0\.tm\.md)| |encodings|[punkshell\_module\_punk::char](doc/files/punk/\_module\_char\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::encmime](doc/files/punk/\_module\_encmime\-0\.1\.0\.tm\.md)| -|experimental|[punkshell\_module\_punk::flib](doc/files/punk/\_module\_flib\-0\.1\.0\.tm\.md)| +|experimental|[punkshell\_module\_punk::cesu](doc/files/punk/\_module\_cesu\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::flib](doc/files/punk/\_module\_flib\-0\.1\.0\.tm\.md)| #### Keywords: F ||| |---|---| +|fake|[fauxlink\_module\_fauxlink](doc/files/\_module\_fauxlink\-0\.1\.1\.tm\.md)| +|faux|[fauxlink\_module\_fauxlink](doc/files/\_module\_fauxlink\-0\.1\.1\.tm\.md)| |file|[punkshell\_module\_punk::fileline](doc/files/punk/\_module\_fileline\-0\.1\.0\.tm\.md)| -|filesystem|[punkshell\_module\_punk::path](doc/files/punk/\_module\_path\-0\.1\.0\.tm\.md) · [shellspy\_module\_punk::island](doc/files/punk/\_module\_island\-0\.1\.0\.tm\.md)| +|fileformat|[punkshell\_module\_punk::zip](doc/files/punk/\_module\_zip\-0\.1\.1\.tm\.md)| +|filesystem|[punkshell\_module\_punk::island](doc/files/punk/\_module\_island\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::path](doc/files/punk/\_module\_path\-0\.1\.0\.tm\.md) · [shellspy\_module\_punk::nav::fs](doc/files/punk/nav/\_module\_fs\-0\.1\.0\.tm\.md)| +|frame|[punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.2\.tm\.md)| + + +#### Keywords: H + +||| +|---|---| +|http|[punkshell\_module\_punk::rest](doc/files/punk/\_module\_rest\-0\.1\.0\.tm\.md)| #### Keywords: I ||| |---|---| -|interp|[shellspy\_module\_punk::island](doc/files/punk/\_module\_island\-0\.1\.0\.tm\.md)| +|interp|[punkshell\_module\_punk::island](doc/files/punk/\_module\_island\-0\.1\.0\.tm\.md)| #### Keywords: L ||| |---|---| +|launcher|[punkshell\_module\_scriptwrap](doc/files/punk/mix/commandset/\_module\_scriptwrap\-0\.1\.0\.tm\.md)| +|layout|[punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.2\.tm\.md)| |lib|[punkshell\_module\_punk::lib](doc/files/punk/\_module\_lib\-0\.1\.1\.tm\.md) · [punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.1\.tm\.md)| +|lnk|[punkshell\_module\_punk::winlnk](doc/files/punk/\_module\_winlnk\-0\.1\.0\.tm\.md)| #### Keywords: M ||| |---|---| -|module|[modpod\_module\_modpod](doc/files/\_module\_modpod\-0\.1\.0\.tm\.md) · [overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.3\.tm\.md) · [overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.4\.tm\.md) · [overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.5\.tm\.md) · [punkshell\_module\_punk::ansi](doc/files/punk/\_module\_ansi\-0\.1\.1\.tm\.md) · [punkshell\_module\_punk::args](doc/files/punk/\_module\_args\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::cap](doc/files/punk/\_module\_cap\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::char](doc/files/punk/\_module\_char\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::console](doc/files/punk/\_module\_console\-0\.1\.1\.tm\.md) · [punkshell\_module\_punk::encmime](doc/files/punk/\_module\_encmime\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::fileline](doc/files/punk/\_module\_fileline\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::flib](doc/files/punk/\_module\_flib\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::lib](doc/files/punk/\_module\_lib\-0\.1\.1\.tm\.md) · [punkshell\_module\_punk::path](doc/files/punk/\_module\_path\-0\.1\.0\.tm\.md) · [punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.1\.tm\.md) · [shellspy\_module\_argparsingtest](doc/files/\_module\_argparsingtest\-0\.1\.0\.tm\.md) · [shellspy\_module\_poshinfo](doc/files/\_module\_poshinfo\-0\.1\.0\.tm\.md) · [shellspy\_module\_punk::aliascore](doc/files/punk/\_module\_aliascore\-0\.1\.0\.tm\.md) · [shellspy\_module\_punk::assertion](doc/files/punk/\_module\_assertion\-0\.1\.0\.tm\.md) · [shellspy\_module\_punk::basictelnet](doc/files/punk/\_module\_basictelnet\-0\.1\.0\.tm\.md) · [shellspy\_module\_punk::experiment](doc/files/punk/\_module\_experiment\-0\.1\.0\.tm\.md) · [shellspy\_module\_punk::island](doc/files/punk/\_module\_island\-0\.1\.0\.tm\.md) · [shellspy\_module\_punk::nav::fs](doc/files/punk/nav/\_module\_fs\-0\.1\.0\.tm\.md) · [shellspy\_module\_punk::packagepreference](doc/files/punk/\_module\_packagepreference\-0\.1\.0\.tm\.md) · [shellspy\_module\_punk::repl::codethread](doc/files/punk/repl/\_module\_codethread\-0\.1\.0\.tm\.md) · [shellspy\_module\_punk::sshrun](doc/files/punk/\_module\_sshrun\-0\.1\.0\.tm\.md) · [shellspy\_module\_punk::uc](doc/files/punk/\_module\_uc\-0\.1\.0\.tm\.md) · [shellspy\_module\_punk::zip](doc/files/punk/\_module\_zip\-0\.1\.0\.tm\.md) · [tomlish\_module\_tomlish](doc/files/\_module\_tomlish\-1\.1\.1\.tm\.md)| +|module|[modpod\_module\_modpod](doc/files/\_module\_modpod\-0\.1\.2\.tm\.md) · [overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.5\.tm\.md) · [punkshell::basictelnet](doc/files/punk/\_module\_basictelnet\-0\.1\.0\.tm\.md) · [punkshell\_module\_argparsingtest](doc/files/\_module\_argparsingtest\-0\.1\.0\.tm\.md) · [punkshell\_module\_poshinfo](doc/files/\_module\_poshinfo\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::aliascore](doc/files/punk/\_module\_aliascore\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::ansi](doc/files/punk/\_module\_ansi\-0\.1\.1\.tm\.md) · [punkshell\_module\_punk::args](doc/files/punk/\_module\_args\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::assertion](doc/files/punk/\_module\_assertion\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::blockletter](doc/files/punk/\_module\_blockletter\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::cap](doc/files/punk/\_module\_cap\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::cesu](doc/files/punk/\_module\_cesu\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::char](doc/files/punk/\_module\_char\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::console](doc/files/punk/\_module\_console\-0\.1\.1\.tm\.md) · [punkshell\_module\_punk::encmime](doc/files/punk/\_module\_encmime\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::experiment](doc/files/punk/\_module\_experiment\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::fileline](doc/files/punk/\_module\_fileline\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::flib](doc/files/punk/\_module\_flib\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::island](doc/files/punk/\_module\_island\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::lib](doc/files/punk/\_module\_lib\-0\.1\.1\.tm\.md) · [punkshell\_module\_punk::packagepreference](doc/files/punk/\_module\_packagepreference\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::path](doc/files/punk/\_module\_path\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::rest](doc/files/punk/\_module\_rest\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::sshrun](doc/files/punk/\_module\_sshrun\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::trie](doc/files/punk/\_module\_trie\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::uc](doc/files/punk/\_module\_uc\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::winlnk](doc/files/punk/\_module\_winlnk\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::zip](doc/files/punk/\_module\_zip\-0\.1\.1\.tm\.md) · [punkshell\_module\_scriptwrap](doc/files/punk/mix/commandset/\_module\_scriptwrap\-0\.1\.0\.tm\.md) · [punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.1\.tm\.md) · [punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.2\.tm\.md) · [shellspy\_module\_punk::nav::fs](doc/files/punk/nav/\_module\_fs\-0\.1\.0\.tm\.md) · [shellspy\_module\_punk::repl::codethread](doc/files/punk/repl/\_module\_codethread\-0\.1\.0\.tm\.md) · [shellspy\_module\_punk::zip](doc/files/punk/\_module\_zip\-0\.1\.0\.tm\.md) · [tomlish\_module\_tomlish](doc/files/\_module\_tomlish\-1\.1\.1\.tm\.md)| #### Keywords: P ||| |---|---| -|parse|[punkshell\_module\_punk::args](doc/files/punk/\_module\_args\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::fileline](doc/files/punk/\_module\_fileline\-0\.1\.0\.tm\.md)| +|package|[punkshell\_module\_punk::packagepreference](doc/files/punk/\_module\_packagepreference\-0\.1\.0\.tm\.md)| +|parse|[punkshell\_module\_punk::args](doc/files/punk/\_module\_args\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::fileline](doc/files/punk/\_module\_fileline\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::winlnk](doc/files/punk/\_module\_winlnk\-0\.1\.0\.tm\.md)| +|parsing|[tomlish\_module\_tomlish](doc/files/\_module\_tomlish\-1\.1\.1\.tm\.md)| |path|[punkshell\_module\_punk::path](doc/files/punk/\_module\_path\-0\.1\.0\.tm\.md)| |plugin|[punkshell\_module\_punk::cap](doc/files/punk/\_module\_cap\-0\.1\.0\.tm\.md)| +|POSH|[punkshell\_module\_poshinfo](doc/files/\_module\_poshinfo\-0\.1\.0\.tm\.md)| |proc|[punkshell\_module\_punk::args](doc/files/punk/\_module\_args\-0\.1\.0\.tm\.md)| +|prompt|[punkshell\_module\_poshinfo](doc/files/\_module\_poshinfo\-0\.1\.0\.tm\.md)| +|prompt theme|[punkshell\_module\_poshinfo](doc/files/\_module\_poshinfo\-0\.1\.0\.tm\.md)| +|protocol|[punkshell::basictelnet](doc/files/punk/\_module\_basictelnet\-0\.1\.0\.tm\.md)| |punk|[punkshell](doc/files/main\.md) · [punkshell\_\_project\_changes](doc/files/project\_changes\.md) · [punkshell\_\_project\_intro](doc/files/project\_intro\.md)| @@ -96,28 +124,54 @@ ||| |---|---| -|repl|[punkshell](doc/files/main\.md) · [punkshell\_\_project\_changes](doc/files/project\_changes\.md) · [punkshell\_\_project\_intro](doc/files/project\_intro\.md)| +|repl|[punkshell](doc/files/main\.md) · [punkshell\_\_project\_changes](doc/files/project\_changes\.md) · [punkshell\_\_project\_intro](doc/files/project\_intro\.md) · [shellspy\_module\_punk::repl::codethread](doc/files/punk/repl/\_module\_codethread\-0\.1\.0\.tm\.md)| +|rest|[punkshell\_module\_punk::rest](doc/files/punk/\_module\_rest\-0\.1\.0\.tm\.md)| #### Keywords: S ||| |---|---| +|scriptwrap|[punkshell\_module\_scriptwrap](doc/files/punk/mix/commandset/\_module\_scriptwrap\-0\.1\.0\.tm\.md)| |shell|[punkshell](doc/files/main\.md) · [punkshell\_\_project\_changes](doc/files/project\_changes\.md) · [punkshell\_\_project\_intro](doc/files/project\_intro\.md)| -|ssh|[shellspy\_module\_punk::sshrun](doc/files/punk/\_module\_sshrun\-0\.1\.0\.tm\.md)| +|shortcut|[fauxlink\_module\_fauxlink](doc/files/\_module\_fauxlink\-0\.1\.1\.tm\.md) · [punkshell\_module\_punk::winlnk](doc/files/punk/\_module\_winlnk\-0\.1\.0\.tm\.md)| +|ssh|[punkshell\_module\_punk::sshrun](doc/files/punk/\_module\_sshrun\-0\.1\.0\.tm\.md)| |string|[punkshell\_module\_punk::ansi](doc/files/punk/\_module\_ansi\-0\.1\.1\.tm\.md)| +|symlink|[fauxlink\_module\_fauxlink](doc/files/\_module\_fauxlink\-0\.1\.1\.tm\.md)| #### Keywords: T ||| |---|---| -|terminal|[punkshell\_module\_punk::ansi](doc/files/punk/\_module\_ansi\-0\.1\.1\.tm\.md) · [punkshell\_module\_punk::console](doc/files/punk/\_module\_console\-0\.1\.1\.tm\.md)| -|text|[overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.3\.tm\.md) · [overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.4\.tm\.md) · [overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.5\.tm\.md) · [punkshell\_module\_punk::fileline](doc/files/punk/\_module\_fileline\-0\.1\.0\.tm\.md)| +|table|[punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.2\.tm\.md)| +|telnet|[punkshell::basictelnet](doc/files/punk/\_module\_basictelnet\-0\.1\.0\.tm\.md)| +|terminal|[punkshell::basictelnet](doc/files/punk/\_module\_basictelnet\-0\.1\.0\.tm\.md) · [punkshell\_module\_poshinfo](doc/files/\_module\_poshinfo\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::ansi](doc/files/punk/\_module\_ansi\-0\.1\.1\.tm\.md) · [punkshell\_module\_punk::console](doc/files/punk/\_module\_console\-0\.1\.1\.tm\.md) · [punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.2\.tm\.md) · [shellspy\_module\_punk::nav::fs](doc/files/punk/nav/\_module\_fs\-0\.1\.0\.tm\.md)| +|text|[overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.5\.tm\.md) · [punkshell\_module\_punk::fileline](doc/files/punk/\_module\_fileline\-0\.1\.0\.tm\.md) · [punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.2\.tm\.md)| +|theme|[punkshell\_module\_poshinfo](doc/files/\_module\_poshinfo\-0\.1\.0\.tm\.md)| +|toml|[fauxlink\_module\_fauxlink](doc/files/\_module\_fauxlink\-0\.1\.1\.tm\.md) · [tomlish\_module\_tomlish](doc/files/\_module\_tomlish\-1\.1\.1\.tm\.md)| +|trie|[punkshell\_module\_punk::trie](doc/files/punk/\_module\_trie\-0\.1\.0\.tm\.md)| #### Keywords: U ||| |---|---| +|unicode|[punkshell\_module\_punk::uc](doc/files/punk/\_module\_uc\-0\.1\.0\.tm\.md)| +|unofficial|[punkshell\_module\_punk::cesu](doc/files/punk/\_module\_cesu\-0\.1\.0\.tm\.md) · [punkshell\_module\_punk::uc](doc/files/punk/\_module\_uc\-0\.1\.0\.tm\.md)| |utility|[punkshell\_module\_punk::lib](doc/files/punk/\_module\_lib\-0\.1\.1\.tm\.md) · [punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.1\.tm\.md)| + + +#### Keywords: W + +||| +|---|---| +|wcswidth|[punkshell\_module\_punk::uc](doc/files/punk/\_module\_uc\-0\.1\.0\.tm\.md)| +|windows|[punkshell\_module\_punk::winlnk](doc/files/punk/\_module\_winlnk\-0\.1\.0\.tm\.md)| + + +#### Keywords: Z + +||| +|---|---| +|zip|[punkshell\_module\_punk::zip](doc/files/punk/\_module\_zip\-0\.1\.1\.tm\.md)| diff --git a/src/embedded/md/toc.md b/src/embedded/md/toc.md index 7fb2eddf..da725603 100644 --- a/src/embedded/md/toc.md +++ b/src/embedded/md/toc.md @@ -3,68 +3,82 @@ # Table Of Contents \-\- doc - - [modpod\_module\_modpod](doc/files/\_module\_modpod\-0\.1\.0\.tm\.md) Module API + - [fauxlink\_module\_fauxlink](doc/files/\_module\_fauxlink\-0\.1\.1\.tm\.md) faux link application shortcuts - - [overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.3\.tm\.md) overtype text layout \- ansi aware - - - [overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.4\.tm\.md) overtype text layout \- ansi aware + - [modpod\_module\_modpod](doc/files/\_module\_modpod\-0\.1\.2\.tm\.md) Module API - [overtype\_module\_overtype](doc/files/\_module\_overtype\-1\.6\.5\.tm\.md) overtype text layout \- ansi aware - [punkshell](doc/files/main\.md) punkshell \- Core + - [punkshell::basictelnet](doc/files/punk/\_module\_basictelnet\-0\.1\.0\.tm\.md) basic telnet client \- DKF/Wiki + - [punkshell\_\_project\_changes](doc/files/project\_changes\.md) punkshell Changes - [punkshell\_\_project\_intro](doc/files/project\_intro\.md) Introduction to punkshell + - [punkshell\_module\_argparsingtest](doc/files/\_module\_argparsingtest\-0\.1\.0\.tm\.md) Module API + + - [punkshell\_module\_poshinfo](doc/files/\_module\_poshinfo\-0\.1\.0\.tm\.md) poshinfo prompt theme tool + + - [punkshell\_module\_punk::aliascore](doc/files/punk/\_module\_aliascore\-0\.1\.0\.tm\.md) punkshell command aliases + - [punkshell\_module\_punk::ansi](doc/files/punk/\_module\_ansi\-0\.1\.1\.tm\.md) Ansi string functions - [punkshell\_module\_punk::args](doc/files/punk/\_module\_args\-0\.1\.0\.tm\.md) args parsing + - [punkshell\_module\_punk::assertion](doc/files/punk/\_module\_assertion\-0\.1\.0\.tm\.md) assertion alternative to control::assert + + - [punkshell\_module\_punk::blockletter](doc/files/punk/\_module\_blockletter\-0\.1\.0\.tm\.md) punk::blockletter frame\-based large lettering test/logo + - [punkshell\_module\_punk::cap](doc/files/punk/\_module\_cap\-0\.1\.0\.tm\.md) capability provider and handler plugin system + - [punkshell\_module\_punk::cesu](doc/files/punk/\_module\_cesu\-0\.1\.0\.tm\.md) CESU compatibility ehcoding scheme for utf\-16: 8\-Bit \(CESU\-8\) ?? + - [punkshell\_module\_punk::char](doc/files/punk/\_module\_char\-0\.1\.0\.tm\.md) character\-set and unicode utilities - [punkshell\_module\_punk::console](doc/files/punk/\_module\_console\-0\.1\.1\.tm\.md) punk console - [punkshell\_module\_punk::encmime](doc/files/punk/\_module\_encmime\-0\.1\.0\.tm\.md) mime encodings related subset of tcllib mime + - [punkshell\_module\_punk::experiment](doc/files/punk/\_module\_experiment\-0\.1\.0\.tm\.md) Module API + - [punkshell\_module\_punk::fileline](doc/files/punk/\_module\_fileline\-0\.1\.0\.tm\.md) file line\-handling utilities - [punkshell\_module\_punk::flib](doc/files/punk/\_module\_flib\-0\.1\.0\.tm\.md) flib experimental + - [punkshell\_module\_punk::island](doc/files/punk/\_module\_island\-0\.1\.0\.tm\.md) filesystem islands for safe interps + - [punkshell\_module\_punk::lib](doc/files/punk/\_module\_lib\-0\.1\.1\.tm\.md) punk general utility functions - [punkshell\_module\_punk::mix::commandset::project](doc/files/punk/mix/commandset/\_module\_project\-0\.1\.0\.tm\.md) dec commandset \- project - - [punkshell\_module\_punk::path](doc/files/punk/\_module\_path\-0\.1\.0\.tm\.md) Filesystem path utilities + - [punkshell\_module\_punk::packagepreference](doc/files/punk/\_module\_packagepreference\-0\.1\.0\.tm\.md) punkshell package/module loading - - [punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.1\.tm\.md) punk textblock functions - - - [shellspy\_module\_argparsingtest](doc/files/\_module\_argparsingtest\-0\.1\.0\.tm\.md) Module API + - [punkshell\_module\_punk::path](doc/files/punk/\_module\_path\-0\.1\.0\.tm\.md) Filesystem path utilities - - [shellspy\_module\_poshinfo](doc/files/\_module\_poshinfo\-0\.1\.0\.tm\.md) Module API + - [punkshell\_module\_punk::rest](doc/files/punk/\_module\_rest\-0\.1\.0\.tm\.md) punk::rest - - [shellspy\_module\_punk::aliascore](doc/files/punk/\_module\_aliascore\-0\.1\.0\.tm\.md) Module API + - [punkshell\_module\_punk::sshrun](doc/files/punk/\_module\_sshrun\-0\.1\.0\.tm\.md) Tcl procedures to execute tcl scripts in remote hosts - - [shellspy\_module\_punk::assertion](doc/files/punk/\_module\_assertion\-0\.1\.0\.tm\.md) assertion alternative to control::assert + - [punkshell\_module\_punk::trie](doc/files/punk/\_module\_trie\-0\.1\.0\.tm\.md) punk::trie API - - [shellspy\_module\_punk::basictelnet](doc/files/punk/\_module\_basictelnet\-0\.1\.0\.tm\.md) basic telnet client \- DKF/Wiki + - [punkshell\_module\_punk::uc](doc/files/punk/\_module\_uc\-0\.1\.0\.tm\.md) Module API - - [shellspy\_module\_punk::experiment](doc/files/punk/\_module\_experiment\-0\.1\.0\.tm\.md) Module API + - [punkshell\_module\_punk::winlnk](doc/files/punk/\_module\_winlnk\-0\.1\.0\.tm\.md) windows shortcut \.lnk library - - [shellspy\_module\_punk::island](doc/files/punk/\_module\_island\-0\.1\.0\.tm\.md) filesystem islands for safe interps + - [punkshell\_module\_punk::zip](doc/files/punk/\_module\_zip\-0\.1\.1\.tm\.md) Module API - - [shellspy\_module\_punk::nav::fs](doc/files/punk/nav/\_module\_fs\-0\.1\.0\.tm\.md) Module API + - [punkshell\_module\_scriptwrap](doc/files/punk/mix/commandset/\_module\_scriptwrap\-0\.1\.0\.tm\.md) scriptwrap polyglot tool - - [shellspy\_module\_punk::packagepreference](doc/files/punk/\_module\_packagepreference\-0\.1\.0\.tm\.md) Module API + - [punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.1\.tm\.md) punk textblock functions - - [shellspy\_module\_punk::repl::codethread](doc/files/punk/repl/\_module\_codethread\-0\.1\.0\.tm\.md) Module API + - [punkshell\_module\_textblock](doc/files/\_module\_textblock\-0\.1\.2\.tm\.md) punk textblock functions - - [shellspy\_module\_punk::sshrun](doc/files/punk/\_module\_sshrun\-0\.1\.0\.tm\.md) Tcl procedures to execute tcl scripts in remote hosts + - [shellspy\_module\_punk::nav::fs](doc/files/punk/nav/\_module\_fs\-0\.1\.0\.tm\.md) punk::nav::fs console filesystem navigation - - [shellspy\_module\_punk::uc](doc/files/punk/\_module\_uc\-0\.1\.0\.tm\.md) Module API + - [shellspy\_module\_punk::repl::codethread](doc/files/punk/repl/\_module\_codethread\-0\.1\.0\.tm\.md) Module repl codethread - [shellspy\_module\_punk::zip](doc/files/punk/\_module\_zip\-0\.1\.0\.tm\.md) Module API - - [tomlish\_module\_tomlish](doc/files/\_module\_tomlish\-1\.1\.1\.tm\.md) Module API + - [tomlish\_module\_tomlish](doc/files/\_module\_tomlish\-1\.1\.1\.tm\.md) tomlish toml parser diff --git a/src/embedded/www/.doc/tocdoc b/src/embedded/www/.doc/tocdoc index ee1df100..539a2e53 100644 --- a/src/embedded/www/.doc/tocdoc +++ b/src/embedded/www/.doc/tocdoc @@ -1,35 +1,42 @@ [toc_begin {Table Of Contents} doc] -[item doc/files/_module_modpod-0.1.0.tm.html modpod_module_modpod {Module API}] -[item doc/files/_module_overtype-1.6.3.tm.html overtype_module_overtype {overtype text layout - ansi aware}] -[item doc/files/_module_overtype-1.6.4.tm.html overtype_module_overtype {overtype text layout - ansi aware}] -[item doc/files/_module_overtype-1.6.5.tm.html overtype_module_overtype {overtype text layout - ansi aware}] -[item doc/files/main.html punkshell {punkshell - Core}] -[item doc/files/project_changes.html punkshell__project_changes {punkshell Changes}] -[item doc/files/project_intro.html punkshell__project_intro {Introduction to punkshell}] -[item doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi {Ansi string functions}] -[item doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args {args parsing}] -[item doc/files/punk/_module_cap-0.1.0.tm.html punkshell_module_punk::cap {capability provider and handler plugin system}] -[item doc/files/punk/_module_char-0.1.0.tm.html punkshell_module_punk::char {character-set and unicode utilities}] -[item doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::console {punk console}] -[item doc/files/punk/_module_encmime-0.1.0.tm.html punkshell_module_punk::encmime {mime encodings related subset of tcllib mime}] -[item doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline {file line-handling utilities}] -[item doc/files/punk/_module_flib-0.1.0.tm.html punkshell_module_punk::flib {flib experimental}] -[item doc/files/punk/_module_lib-0.1.1.tm.html punkshell_module_punk::lib {punk general utility functions}] -[item doc/files/punk/mix/commandset/_module_project-0.1.0.tm.html punkshell_module_punk::mix::commandset::project {dec commandset - project}] -[item doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::path {Filesystem path utilities}] -[item doc/files/_module_textblock-0.1.1.tm.html punkshell_module_textblock {punk textblock functions}] -[item doc/files/_module_argparsingtest-0.1.0.tm.html shellspy_module_argparsingtest {Module API}] -[item doc/files/_module_poshinfo-0.1.0.tm.html shellspy_module_poshinfo {Module API}] -[item doc/files/punk/_module_aliascore-0.1.0.tm.html shellspy_module_punk::aliascore {Module API}] -[item doc/files/punk/_module_assertion-0.1.0.tm.html shellspy_module_punk::assertion {assertion alternative to control::assert}] -[item doc/files/punk/_module_basictelnet-0.1.0.tm.html shellspy_module_punk::basictelnet {basic telnet client - DKF/Wiki}] -[item doc/files/punk/_module_experiment-0.1.0.tm.html shellspy_module_punk::experiment {Module API}] -[item doc/files/punk/_module_island-0.1.0.tm.html shellspy_module_punk::island {filesystem islands for safe interps}] -[item doc/files/punk/nav/_module_fs-0.1.0.tm.html shellspy_module_punk::nav::fs {Module API}] -[item doc/files/punk/_module_packagepreference-0.1.0.tm.html shellspy_module_punk::packagepreference {Module API}] -[item doc/files/punk/repl/_module_codethread-0.1.0.tm.html shellspy_module_punk::repl::codethread {Module API}] -[item doc/files/punk/_module_sshrun-0.1.0.tm.html shellspy_module_punk::sshrun {Tcl procedures to execute tcl scripts in remote hosts}] -[item doc/files/punk/_module_uc-0.1.0.tm.html shellspy_module_punk::uc {Module API}] -[item doc/files/punk/_module_zip-0.1.0.tm.html shellspy_module_punk::zip {Module API}] -[item doc/files/_module_tomlish-1.1.1.tm.html tomlish_module_tomlish {Module API}] +[item doc/files/_module_fauxlink-0.1.1.tm.html fauxlink_module_fauxlink {faux link application shortcuts}] +[item doc/files/_module_modpod-0.1.2.tm.html modpod_module_modpod {Module API}] +[item doc/files/_module_overtype-1.6.5.tm.html overtype_module_overtype {overtype text layout - ansi aware}] +[item doc/files/main.html punkshell {punkshell - Core}] +[item doc/files/punk/_module_basictelnet-0.1.0.tm.html punkshell::basictelnet {basic telnet client - DKF/Wiki}] +[item doc/files/project_changes.html punkshell__project_changes {punkshell Changes}] +[item doc/files/project_intro.html punkshell__project_intro {Introduction to punkshell}] +[item doc/files/_module_argparsingtest-0.1.0.tm.html punkshell_module_argparsingtest {Module API}] +[item doc/files/_module_poshinfo-0.1.0.tm.html punkshell_module_poshinfo {poshinfo prompt theme tool}] +[item doc/files/punk/_module_aliascore-0.1.0.tm.html punkshell_module_punk::aliascore {punkshell command aliases}] +[item doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi {Ansi string functions}] +[item doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args {args parsing}] +[item doc/files/punk/_module_assertion-0.1.0.tm.html punkshell_module_punk::assertion {assertion alternative to control::assert}] +[item doc/files/punk/_module_blockletter-0.1.0.tm.html punkshell_module_punk::blockletter {punk::blockletter frame-based large lettering test/logo}] +[item doc/files/punk/_module_cap-0.1.0.tm.html punkshell_module_punk::cap {capability provider and handler plugin system}] +[item doc/files/punk/_module_cesu-0.1.0.tm.html punkshell_module_punk::cesu {CESU compatibility ehcoding scheme for utf-16: 8-Bit (CESU-8) ??}] +[item doc/files/punk/_module_char-0.1.0.tm.html punkshell_module_punk::char {character-set and unicode utilities}] +[item doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::console {punk console}] +[item doc/files/punk/_module_encmime-0.1.0.tm.html punkshell_module_punk::encmime {mime encodings related subset of tcllib mime}] +[item doc/files/punk/_module_experiment-0.1.0.tm.html punkshell_module_punk::experiment {Module API}] +[item doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline {file line-handling utilities}] +[item doc/files/punk/_module_flib-0.1.0.tm.html punkshell_module_punk::flib {flib experimental}] +[item doc/files/punk/_module_island-0.1.0.tm.html punkshell_module_punk::island {filesystem islands for safe interps}] +[item doc/files/punk/_module_lib-0.1.1.tm.html punkshell_module_punk::lib {punk general utility functions}] +[item doc/files/punk/mix/commandset/_module_project-0.1.0.tm.html punkshell_module_punk::mix::commandset::project {dec commandset - project}] +[item doc/files/punk/_module_packagepreference-0.1.0.tm.html punkshell_module_punk::packagepreference {punkshell package/module loading}] +[item doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::path {Filesystem path utilities}] +[item doc/files/punk/_module_rest-0.1.0.tm.html punkshell_module_punk::rest punk::rest] +[item doc/files/punk/_module_sshrun-0.1.0.tm.html punkshell_module_punk::sshrun {Tcl procedures to execute tcl scripts in remote hosts}] +[item doc/files/punk/_module_trie-0.1.0.tm.html punkshell_module_punk::trie {punk::trie API}] +[item doc/files/punk/_module_uc-0.1.0.tm.html punkshell_module_punk::uc {Module API}] +[item doc/files/punk/_module_winlnk-0.1.0.tm.html punkshell_module_punk::winlnk {windows shortcut .lnk library}] +[item doc/files/punk/_module_zip-0.1.1.tm.html punkshell_module_punk::zip {Module API}] +[item doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.html punkshell_module_scriptwrap {scriptwrap polyglot tool}] +[item doc/files/_module_textblock-0.1.1.tm.html punkshell_module_textblock {punk textblock functions}] +[item doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock {punk textblock functions}] +[item doc/files/punk/nav/_module_fs-0.1.0.tm.html shellspy_module_punk::nav::fs {punk::nav::fs console filesystem navigation}] +[item doc/files/punk/repl/_module_codethread-0.1.0.tm.html shellspy_module_punk::repl::codethread {Module repl codethread}] +[item doc/files/punk/_module_zip-0.1.0.tm.html shellspy_module_punk::zip {Module API}] +[item doc/files/_module_tomlish-1.1.1.tm.html tomlish_module_tomlish {tomlish toml parser}] [toc_end] diff --git a/src/embedded/www/.idx b/src/embedded/www/.idx index b38de61b..2cf06236 100644 --- a/src/embedded/www/.idx +++ b/src/embedded/www/.idx @@ -1 +1 @@ -{file {{doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline}} assertion {{doc/files/punk/_module_assertion-0.1.0.tm.html shellspy_module_punk::assertion}} assert {{doc/files/punk/_module_assertion-0.1.0.tm.html shellspy_module_punk::assertion}} encodings {{doc/files/punk/_module_encmime-0.1.0.tm.html punkshell_module_punk::encmime} {doc/files/punk/_module_char-0.1.0.tm.html punkshell_module_punk::char}} repl {{doc/files/project_changes.html punkshell__project_changes} {doc/files/project_intro.html punkshell__project_intro} {doc/files/main.html punkshell}} console {{doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} {doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::console}} utility {{doc/files/punk/_module_lib-0.1.1.tm.html punkshell_module_punk::lib} {doc/files/_module_textblock-0.1.1.tm.html punkshell_module_textblock}} text {{doc/files/_module_overtype-1.6.3.tm.html overtype_module_overtype} {doc/files/_module_overtype-1.6.4.tm.html overtype_module_overtype} {doc/files/_module_overtype-1.6.5.tm.html overtype_module_overtype} {doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline}} BOM {{doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline}} experimental {{doc/files/punk/_module_flib-0.1.0.tm.html punkshell_module_punk::flib}} ssh {{doc/files/punk/_module_sshrun-0.1.0.tm.html shellspy_module_punk::sshrun}} arguments {{doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args}} debug {{doc/files/punk/_module_assertion-0.1.0.tm.html shellspy_module_punk::assertion}} encoding {{doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline}} changelog {{doc/files/project_changes.html punkshell__project_changes}} shell {{doc/files/project_changes.html punkshell__project_changes} {doc/files/project_intro.html punkshell__project_intro} {doc/files/main.html punkshell}} capability {{doc/files/punk/_module_cap-0.1.0.tm.html punkshell_module_punk::cap}} interp {{doc/files/punk/_module_island-0.1.0.tm.html shellspy_module_punk::island}} ansi {{doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} {doc/files/_module_overtype-1.6.3.tm.html overtype_module_overtype} {doc/files/_module_overtype-1.6.4.tm.html overtype_module_overtype} {doc/files/_module_overtype-1.6.5.tm.html overtype_module_overtype}} parse {{doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args} {doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline}} proc {{doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args}} terminal {{doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} {doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::console}} args {{doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args}} path {{doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::path}} filesystem {{doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::path} {doc/files/punk/_module_island-0.1.0.tm.html shellspy_module_punk::island}} module {{doc/files/punk/_module_cap-0.1.0.tm.html punkshell_module_punk::cap} {doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} {doc/files/punk/repl/_module_codethread-0.1.0.tm.html shellspy_module_punk::repl::codethread} {doc/files/punk/nav/_module_fs-0.1.0.tm.html shellspy_module_punk::nav::fs} {doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::path} {doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args} {doc/files/punk/_module_encmime-0.1.0.tm.html punkshell_module_punk::encmime} {doc/files/punk/_module_char-0.1.0.tm.html punkshell_module_punk::char} {doc/files/_module_modpod-0.1.0.tm.html modpod_module_modpod} {doc/files/punk/_module_uc-0.1.0.tm.html shellspy_module_punk::uc} {doc/files/punk/_module_lib-0.1.1.tm.html punkshell_module_punk::lib} {doc/files/punk/_module_assertion-0.1.0.tm.html shellspy_module_punk::assertion} {doc/files/punk/_module_experiment-0.1.0.tm.html shellspy_module_punk::experiment} {doc/files/_module_poshinfo-0.1.0.tm.html shellspy_module_poshinfo} {doc/files/_module_argparsingtest-0.1.0.tm.html shellspy_module_argparsingtest} {doc/files/_module_overtype-1.6.3.tm.html overtype_module_overtype} {doc/files/punk/_module_sshrun-0.1.0.tm.html shellspy_module_punk::sshrun} {doc/files/punk/_module_packagepreference-0.1.0.tm.html shellspy_module_punk::packagepreference} {doc/files/punk/_module_island-0.1.0.tm.html shellspy_module_punk::island} {doc/files/punk/_module_aliascore-0.1.0.tm.html shellspy_module_punk::aliascore} {doc/files/_module_overtype-1.6.4.tm.html overtype_module_overtype} {doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::console} {doc/files/_module_textblock-0.1.1.tm.html punkshell_module_textblock} {doc/files/_module_overtype-1.6.5.tm.html overtype_module_overtype} {doc/files/punk/_module_flib-0.1.0.tm.html punkshell_module_punk::flib} {doc/files/_module_tomlish-1.1.1.tm.html tomlish_module_tomlish} {doc/files/punk/_module_basictelnet-0.1.0.tm.html shellspy_module_punk::basictelnet} {doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline} {doc/files/punk/_module_zip-0.1.0.tm.html shellspy_module_punk::zip}} punk {{doc/files/project_changes.html punkshell__project_changes} {doc/files/project_intro.html punkshell__project_intro} {doc/files/main.html punkshell}} string {{doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi}} plugin {{doc/files/punk/_module_cap-0.1.0.tm.html punkshell_module_punk::cap}} lib {{doc/files/punk/_module_lib-0.1.1.tm.html punkshell_module_punk::lib} {doc/files/_module_textblock-0.1.1.tm.html punkshell_module_textblock}}} {{module doc/files/_module_textblock-0.1.1.tm.html punkshell_module_textblock} . {ansi doc/files/_module_overtype-1.6.3.tm.html overtype_module_overtype} . {module doc/files/punk/_module_packagepreference-0.1.0.tm.html shellspy_module_punk::packagepreference} . {ssh doc/files/punk/_module_sshrun-0.1.0.tm.html shellspy_module_punk::sshrun} . {ansi doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} . {module doc/files/punk/_module_aliascore-0.1.0.tm.html shellspy_module_punk::aliascore} . {module doc/files/punk/nav/_module_fs-0.1.0.tm.html shellspy_module_punk::nav::fs} . {changelog doc/files/project_changes.html punkshell__project_changes} . {shell doc/files/main.html punkshell} . {module doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::console} . {utility doc/files/_module_textblock-0.1.1.tm.html punkshell_module_textblock} . {module doc/files/_module_overtype-1.6.5.tm.html overtype_module_overtype} . {interp doc/files/punk/_module_island-0.1.0.tm.html shellspy_module_punk::island} . {string doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} . {proc doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args} . {encoding doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline} . {path doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::path} . {plugin doc/files/punk/_module_cap-0.1.0.tm.html punkshell_module_punk::cap} . {args doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args} . {module doc/files/punk/_module_flib-0.1.0.tm.html punkshell_module_punk::flib} . {ansi doc/files/_module_overtype-1.6.4.tm.html overtype_module_overtype} . {punk doc/files/project_changes.html punkshell__project_changes} . {module doc/files/punk/_module_char-0.1.0.tm.html punkshell_module_punk::char} . {module doc/files/punk/_module_assertion-0.1.0.tm.html shellspy_module_punk::assertion} . {debug doc/files/punk/_module_assertion-0.1.0.tm.html shellspy_module_punk::assertion} . {repl doc/files/project_changes.html punkshell__project_changes} . {arguments doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args} . {punk doc/files/project_intro.html punkshell__project_intro} . {capability doc/files/punk/_module_cap-0.1.0.tm.html punkshell_module_punk::cap} . {ansi doc/files/_module_overtype-1.6.5.tm.html overtype_module_overtype} . {terminal doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} . {utility doc/files/punk/_module_lib-0.1.1.tm.html punkshell_module_punk::lib} . {shell doc/files/project_changes.html punkshell__project_changes} . {module doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} . {BOM doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline} . {module doc/files/punk/_module_experiment-0.1.0.tm.html shellspy_module_punk::experiment} . {module doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::path} . {module doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args} . {console doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::console} . {shell doc/files/project_intro.html punkshell__project_intro} . {text doc/files/_module_overtype-1.6.3.tm.html overtype_module_overtype} . {module doc/files/punk/_module_uc-0.1.0.tm.html shellspy_module_punk::uc} . {module doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline} . {encodings doc/files/punk/_module_encmime-0.1.0.tm.html punkshell_module_punk::encmime} . {lib doc/files/punk/_module_lib-0.1.1.tm.html punkshell_module_punk::lib} . {file doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline} . {repl doc/files/main.html punkshell} . {module doc/files/punk/_module_zip-0.1.0.tm.html shellspy_module_punk::zip} . {terminal doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::console} . {module doc/files/_module_tomlish-1.1.1.tm.html tomlish_module_tomlish} . {text doc/files/_module_overtype-1.6.4.tm.html overtype_module_overtype} . {text doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline} . {module doc/files/punk/_module_cap-0.1.0.tm.html punkshell_module_punk::cap} . {lib doc/files/_module_textblock-0.1.1.tm.html punkshell_module_textblock} . {module doc/files/punk/_module_sshrun-0.1.0.tm.html shellspy_module_punk::sshrun} . {module doc/files/punk/_module_island-0.1.0.tm.html shellspy_module_punk::island} . {module doc/files/punk/repl/_module_codethread-0.1.0.tm.html shellspy_module_punk::repl::codethread} . {text doc/files/_module_overtype-1.6.5.tm.html overtype_module_overtype} . {encodings doc/files/punk/_module_char-0.1.0.tm.html punkshell_module_punk::char} . {assert doc/files/punk/_module_assertion-0.1.0.tm.html shellspy_module_punk::assertion} . {experimental doc/files/punk/_module_flib-0.1.0.tm.html punkshell_module_punk::flib} . {filesystem doc/files/punk/_module_island-0.1.0.tm.html shellspy_module_punk::island} . {module doc/files/_module_overtype-1.6.3.tm.html overtype_module_overtype} . {repl doc/files/project_intro.html punkshell__project_intro} . {parse doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args} . {filesystem doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::path} . {module doc/files/punk/_module_basictelnet-0.1.0.tm.html shellspy_module_punk::basictelnet} . {module doc/files/_module_argparsingtest-0.1.0.tm.html shellspy_module_argparsingtest} . {module doc/files/_module_poshinfo-0.1.0.tm.html shellspy_module_poshinfo} . {module doc/files/_module_modpod-0.1.0.tm.html modpod_module_modpod} . {module doc/files/punk/_module_encmime-0.1.0.tm.html punkshell_module_punk::encmime} . {console doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} . {punk doc/files/main.html punkshell} . {parse doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline} . {module doc/files/punk/_module_lib-0.1.1.tm.html punkshell_module_punk::lib} . {module doc/files/_module_overtype-1.6.4.tm.html overtype_module_overtype} . {assertion doc/files/punk/_module_assertion-0.1.0.tm.html shellspy_module_punk::assertion} .} 30 {assertion assertion file file encodings encodings assert assert console console repl repl utility utility text text arguments arguments ssh ssh experimental experimental BOM bom debug debug encoding encoding changelog changelog shell shell capability capability interp interp ansi ansi parse parse terminal terminal proc proc filesystem filesystem path path args args module module punk punk plugin plugin string string lib lib} \ No newline at end of file +{assertion {{doc/files/punk/_module_assertion-0.1.0.tm.html punkshell_module_punk::assertion}} fileformat {{doc/files/punk/_module_zip-0.1.1.tm.html punkshell_module_punk::zip}} POSH {{doc/files/_module_poshinfo-0.1.0.tm.html punkshell_module_poshinfo}} assert {{doc/files/punk/_module_assertion-0.1.0.tm.html punkshell_module_punk::assertion}} debug {{doc/files/punk/_module_assertion-0.1.0.tm.html punkshell_module_punk::assertion}} theme {{doc/files/_module_poshinfo-0.1.0.tm.html punkshell_module_poshinfo}} windows {{doc/files/punk/_module_winlnk-0.1.0.tm.html punkshell_module_punk::winlnk}} proc {{doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args}} filesystem {{doc/files/punk/nav/_module_fs-0.1.0.tm.html shellspy_module_punk::nav::fs} {doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::path} {doc/files/punk/_module_island-0.1.0.tm.html punkshell_module_punk::island}} layout {{doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock}} fake {{doc/files/_module_fauxlink-0.1.1.tm.html fauxlink_module_fauxlink}} datastructure {{doc/files/punk/_module_trie-0.1.0.tm.html punkshell_module_punk::trie}} utility {{doc/files/punk/_module_lib-0.1.1.tm.html punkshell_module_punk::lib} {doc/files/_module_textblock-0.1.1.tm.html punkshell_module_textblock}} wcswidth {{doc/files/punk/_module_uc-0.1.0.tm.html punkshell_module_punk::uc}} rest {{doc/files/punk/_module_rest-0.1.0.tm.html punkshell_module_punk::rest}} ssh {{doc/files/punk/_module_sshrun-0.1.0.tm.html punkshell_module_punk::sshrun}} scriptwrap {{doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.html punkshell_module_scriptwrap}} changelog {{doc/files/project_changes.html punkshell__project_changes}} launcher {{doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.html punkshell_module_scriptwrap}} prompt {{doc/files/_module_poshinfo-0.1.0.tm.html punkshell_module_poshinfo}} terminal {{doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} {doc/files/punk/nav/_module_fs-0.1.0.tm.html shellspy_module_punk::nav::fs} {doc/files/_module_poshinfo-0.1.0.tm.html punkshell_module_poshinfo} {doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::console} {doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock} {doc/files/punk/_module_basictelnet-0.1.0.tm.html punkshell::basictelnet}} path {{doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::path}} args {{doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args}} crossplatform {{doc/files/punk/_module_winlnk-0.1.0.tm.html punkshell_module_punk::winlnk}} file {{doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline}} http {{doc/files/punk/_module_rest-0.1.0.tm.html punkshell_module_punk::rest}} unofficial {{doc/files/punk/_module_uc-0.1.0.tm.html punkshell_module_punk::uc} {doc/files/punk/_module_cesu-0.1.0.tm.html punkshell_module_punk::cesu}} cesu {{doc/files/punk/_module_cesu-0.1.0.tm.html punkshell_module_punk::cesu}} configuration {{doc/files/_module_tomlish-1.1.1.tm.html tomlish_module_tomlish}} table {{doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock}} encodings {{doc/files/punk/_module_encmime-0.1.0.tm.html punkshell_module_punk::encmime} {doc/files/punk/_module_char-0.1.0.tm.html punkshell_module_punk::char}} compatibility {{doc/files/punk/_module_cesu-0.1.0.tm.html punkshell_module_punk::cesu}} alias {{doc/files/punk/_module_aliascore-0.1.0.tm.html punkshell_module_punk::aliascore}} package {{doc/files/punk/_module_packagepreference-0.1.0.tm.html punkshell_module_punk::packagepreference}} parsing {{doc/files/_module_tomlish-1.1.1.tm.html tomlish_module_tomlish}} colour {{doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock}} {prompt theme} {{doc/files/_module_poshinfo-0.1.0.tm.html punkshell_module_poshinfo}} experimental {{doc/files/punk/_module_cesu-0.1.0.tm.html punkshell_module_punk::cesu} {doc/files/punk/_module_flib-0.1.0.tm.html punkshell_module_punk::flib}} shell {{doc/files/project_changes.html punkshell__project_changes} {doc/files/project_intro.html punkshell__project_intro} {doc/files/main.html punkshell}} capability {{doc/files/punk/_module_cap-0.1.0.tm.html punkshell_module_punk::cap}} commandset {{doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.html punkshell_module_scriptwrap}} parse {{doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args} {doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline} {doc/files/punk/_module_winlnk-0.1.0.tm.html punkshell_module_punk::winlnk}} frame {{doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock}} repl {{doc/files/punk/repl/_module_codethread-0.1.0.tm.html shellspy_module_punk::repl::codethread} {doc/files/project_changes.html punkshell__project_changes} {doc/files/project_intro.html punkshell__project_intro} {doc/files/main.html punkshell}} console {{doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} {doc/files/_module_poshinfo-0.1.0.tm.html punkshell_module_poshinfo} {doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::console} {doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock} {doc/files/punk/_module_basictelnet-0.1.0.tm.html punkshell::basictelnet}} shortcut {{doc/files/_module_fauxlink-0.1.1.tm.html fauxlink_module_fauxlink} {doc/files/punk/_module_winlnk-0.1.0.tm.html punkshell_module_punk::winlnk}} telnet {{doc/files/punk/_module_basictelnet-0.1.0.tm.html punkshell::basictelnet}} toml {{doc/files/_module_tomlish-1.1.1.tm.html tomlish_module_tomlish} {doc/files/_module_fauxlink-0.1.1.tm.html fauxlink_module_fauxlink}} text {{doc/files/_module_overtype-1.6.5.tm.html overtype_module_overtype} {doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock} {doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline}} lnk {{doc/files/punk/_module_winlnk-0.1.0.tm.html punkshell_module_punk::winlnk}} arguments {{doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args}} BOM {{doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline}} encoding {{doc/files/punk/_module_cesu-0.1.0.tm.html punkshell_module_punk::cesu} {doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline}} interp {{doc/files/punk/_module_island-0.1.0.tm.html punkshell_module_punk::island}} protocol {{doc/files/punk/_module_basictelnet-0.1.0.tm.html punkshell::basictelnet}} zip {{doc/files/punk/_module_zip-0.1.1.tm.html punkshell_module_punk::zip}} ansi {{doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} {doc/files/_module_overtype-1.6.5.tm.html overtype_module_overtype} {doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock}} trie {{doc/files/punk/_module_trie-0.1.0.tm.html punkshell_module_punk::trie}} faux {{doc/files/_module_fauxlink-0.1.1.tm.html fauxlink_module_fauxlink}} punk {{doc/files/project_changes.html punkshell__project_changes} {doc/files/project_intro.html punkshell__project_intro} {doc/files/main.html punkshell}} module {{doc/files/punk/_module_zip-0.1.1.tm.html punkshell_module_punk::zip} {doc/files/punk/_module_trie-0.1.0.tm.html punkshell_module_punk::trie} {doc/files/punk/_module_cap-0.1.0.tm.html punkshell_module_punk::cap} {doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} {doc/files/punk/repl/_module_codethread-0.1.0.tm.html shellspy_module_punk::repl::codethread} {doc/files/punk/nav/_module_fs-0.1.0.tm.html shellspy_module_punk::nav::fs} {doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::path} {doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args} {doc/files/punk/_module_encmime-0.1.0.tm.html punkshell_module_punk::encmime} {doc/files/punk/_module_char-0.1.0.tm.html punkshell_module_punk::char} {doc/files/punk/_module_uc-0.1.0.tm.html punkshell_module_punk::uc} {doc/files/punk/_module_lib-0.1.1.tm.html punkshell_module_punk::lib} {doc/files/punk/_module_cesu-0.1.0.tm.html punkshell_module_punk::cesu} {doc/files/punk/_module_assertion-0.1.0.tm.html punkshell_module_punk::assertion} {doc/files/_module_modpod-0.1.2.tm.html modpod_module_modpod} {doc/files/punk/_module_experiment-0.1.0.tm.html punkshell_module_punk::experiment} {doc/files/_module_poshinfo-0.1.0.tm.html punkshell_module_poshinfo} {doc/files/_module_argparsingtest-0.1.0.tm.html punkshell_module_argparsingtest} {doc/files/punk/_module_sshrun-0.1.0.tm.html punkshell_module_punk::sshrun} {doc/files/punk/_module_packagepreference-0.1.0.tm.html punkshell_module_punk::packagepreference} {doc/files/punk/_module_island-0.1.0.tm.html punkshell_module_punk::island} {doc/files/punk/_module_aliascore-0.1.0.tm.html punkshell_module_punk::aliascore} {doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::console} {doc/files/_module_textblock-0.1.1.tm.html punkshell_module_textblock} {doc/files/_module_overtype-1.6.5.tm.html overtype_module_overtype} {doc/files/punk/_module_flib-0.1.0.tm.html punkshell_module_punk::flib} {doc/files/_module_tomlish-1.1.1.tm.html tomlish_module_tomlish} {doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock} {doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.html punkshell_module_scriptwrap} {doc/files/punk/_module_rest-0.1.0.tm.html punkshell_module_punk::rest} {doc/files/punk/_module_basictelnet-0.1.0.tm.html punkshell::basictelnet} {doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline} {doc/files/punk/_module_zip-0.1.0.tm.html shellspy_module_punk::zip} {doc/files/punk/_module_winlnk-0.1.0.tm.html punkshell_module_punk::winlnk} {doc/files/punk/_module_blockletter-0.1.0.tm.html punkshell_module_punk::blockletter}} lib {{doc/files/punk/_module_lib-0.1.1.tm.html punkshell_module_punk::lib} {doc/files/_module_textblock-0.1.1.tm.html punkshell_module_textblock}} unicode {{doc/files/punk/_module_uc-0.1.0.tm.html punkshell_module_punk::uc}} plugin {{doc/files/punk/_module_cap-0.1.0.tm.html punkshell_module_punk::cap}} string {{doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi}} symlink {{doc/files/_module_fauxlink-0.1.1.tm.html fauxlink_module_fauxlink}}} {{repl doc/files/punk/repl/_module_codethread-0.1.0.tm.html shellspy_module_punk::repl::codethread} . {module doc/files/_module_textblock-0.1.1.tm.html punkshell_module_textblock} . {terminal doc/files/punk/nav/_module_fs-0.1.0.tm.html shellspy_module_punk::nav::fs} . {fake doc/files/_module_fauxlink-0.1.1.tm.html fauxlink_module_fauxlink} . {parse doc/files/punk/_module_winlnk-0.1.0.tm.html punkshell_module_punk::winlnk} . {filesystem doc/files/punk/nav/_module_fs-0.1.0.tm.html shellspy_module_punk::nav::fs} . {ansi doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} . {module doc/files/punk/nav/_module_fs-0.1.0.tm.html shellspy_module_punk::nav::fs} . {changelog doc/files/project_changes.html punkshell__project_changes} . {module doc/files/punk/_module_winlnk-0.1.0.tm.html punkshell_module_punk::winlnk} . {shell doc/files/main.html punkshell} . {module doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::console} . {terminal doc/files/punk/_module_basictelnet-0.1.0.tm.html punkshell::basictelnet} . {module doc/files/_module_overtype-1.6.5.tm.html overtype_module_overtype} . {utility doc/files/_module_textblock-0.1.1.tm.html punkshell_module_textblock} . {string doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} . {module doc/files/punk/_module_trie-0.1.0.tm.html punkshell_module_punk::trie} . {proc doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args} . {encoding doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline} . {plugin doc/files/punk/_module_cap-0.1.0.tm.html punkshell_module_punk::cap} . {path doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::path} . {args doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args} . {module doc/files/punk/_module_flib-0.1.0.tm.html punkshell_module_punk::flib} . {punk doc/files/project_changes.html punkshell__project_changes} . {module doc/files/punk/_module_char-0.1.0.tm.html punkshell_module_punk::char} . {table doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock} . {datastructure doc/files/punk/_module_trie-0.1.0.tm.html punkshell_module_punk::trie} . {ssh doc/files/punk/_module_sshrun-0.1.0.tm.html punkshell_module_punk::sshrun} . {module doc/files/_module_modpod-0.1.2.tm.html modpod_module_modpod} . {commandset doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.html punkshell_module_scriptwrap} . {module doc/files/punk/_module_uc-0.1.0.tm.html punkshell_module_punk::uc} . {module doc/files/punk/_module_cesu-0.1.0.tm.html punkshell_module_punk::cesu} . {repl doc/files/project_changes.html punkshell__project_changes} . {module doc/files/punk/_module_experiment-0.1.0.tm.html punkshell_module_punk::experiment} . {punk doc/files/project_intro.html punkshell__project_intro} . {arguments doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args} . {unofficial doc/files/punk/_module_uc-0.1.0.tm.html punkshell_module_punk::uc} . {unofficial doc/files/punk/_module_cesu-0.1.0.tm.html punkshell_module_punk::cesu} . {cesu doc/files/punk/_module_cesu-0.1.0.tm.html punkshell_module_punk::cesu} . {capability doc/files/punk/_module_cap-0.1.0.tm.html punkshell_module_punk::cap} . {ansi doc/files/_module_overtype-1.6.5.tm.html overtype_module_overtype} . {module doc/files/_module_argparsingtest-0.1.0.tm.html punkshell_module_argparsingtest} . {terminal doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} . {utility doc/files/punk/_module_lib-0.1.1.tm.html punkshell_module_punk::lib} . {shell doc/files/project_changes.html punkshell__project_changes} . {module doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} . {module doc/files/punk/_module_zip-0.1.1.tm.html punkshell_module_punk::zip} . {wcswidth doc/files/punk/_module_uc-0.1.0.tm.html punkshell_module_punk::uc} . {console doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock} . {frame doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock} . {BOM doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline} . {POSH doc/files/_module_poshinfo-0.1.0.tm.html punkshell_module_poshinfo} . {module doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args} . {module doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::path} . {parsing doc/files/_module_tomlish-1.1.1.tm.html tomlish_module_tomlish} . {module doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock} . {shell doc/files/project_intro.html punkshell__project_intro} . {{prompt theme} doc/files/_module_poshinfo-0.1.0.tm.html punkshell_module_poshinfo} . {console doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::console} . {scriptwrap doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.html punkshell_module_scriptwrap} . {module doc/files/punk/_module_rest-0.1.0.tm.html punkshell_module_punk::rest} . {shortcut doc/files/punk/_module_winlnk-0.1.0.tm.html punkshell_module_punk::winlnk} . {http doc/files/punk/_module_rest-0.1.0.tm.html punkshell_module_punk::rest} . {console doc/files/punk/_module_basictelnet-0.1.0.tm.html punkshell::basictelnet} . {lib doc/files/punk/_module_lib-0.1.1.tm.html punkshell_module_punk::lib} . {encodings doc/files/punk/_module_encmime-0.1.0.tm.html punkshell_module_punk::encmime} . {ansi doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock} . {telnet doc/files/punk/_module_basictelnet-0.1.0.tm.html punkshell::basictelnet} . {module doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline} . {unicode doc/files/punk/_module_uc-0.1.0.tm.html punkshell_module_punk::uc} . {console doc/files/_module_poshinfo-0.1.0.tm.html punkshell_module_poshinfo} . {alias doc/files/punk/_module_aliascore-0.1.0.tm.html punkshell_module_punk::aliascore} . {repl doc/files/main.html punkshell} . {file doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline} . {terminal doc/files/_module_poshinfo-0.1.0.tm.html punkshell_module_poshinfo} . {windows doc/files/punk/_module_winlnk-0.1.0.tm.html punkshell_module_punk::winlnk} . {package doc/files/punk/_module_packagepreference-0.1.0.tm.html punkshell_module_punk::packagepreference} . {module doc/files/punk/_module_zip-0.1.0.tm.html shellspy_module_punk::zip} . {terminal doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::console} . {module doc/files/_module_tomlish-1.1.1.tm.html tomlish_module_tomlish} . {trie doc/files/punk/_module_trie-0.1.0.tm.html punkshell_module_punk::trie} . {protocol doc/files/punk/_module_basictelnet-0.1.0.tm.html punkshell::basictelnet} . {launcher doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.html punkshell_module_scriptwrap} . {text doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline} . {module doc/files/punk/_module_cap-0.1.0.tm.html punkshell_module_punk::cap} . {terminal doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock} . {text doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock} . {module doc/files/punk/_module_basictelnet-0.1.0.tm.html punkshell::basictelnet} . {lib doc/files/_module_textblock-0.1.1.tm.html punkshell_module_textblock} . {toml doc/files/_module_tomlish-1.1.1.tm.html tomlish_module_tomlish} . {layout doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock} . {module doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.html punkshell_module_scriptwrap} . {module doc/files/punk/repl/_module_codethread-0.1.0.tm.html shellspy_module_punk::repl::codethread} . {lnk doc/files/punk/_module_winlnk-0.1.0.tm.html punkshell_module_punk::winlnk} . {text doc/files/_module_overtype-1.6.5.tm.html overtype_module_overtype} . {encodings doc/files/punk/_module_char-0.1.0.tm.html punkshell_module_punk::char} . {module doc/files/punk/_module_assertion-0.1.0.tm.html punkshell_module_punk::assertion} . {prompt doc/files/_module_poshinfo-0.1.0.tm.html punkshell_module_poshinfo} . {colour doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock} . {assertion doc/files/punk/_module_assertion-0.1.0.tm.html punkshell_module_punk::assertion} . {interp doc/files/punk/_module_island-0.1.0.tm.html punkshell_module_punk::island} . {experimental doc/files/punk/_module_flib-0.1.0.tm.html punkshell_module_punk::flib} . {symlink doc/files/_module_fauxlink-0.1.1.tm.html fauxlink_module_fauxlink} . {compatibility doc/files/punk/_module_cesu-0.1.0.tm.html punkshell_module_punk::cesu} . {zip doc/files/punk/_module_zip-0.1.1.tm.html punkshell_module_punk::zip} . {assert doc/files/punk/_module_assertion-0.1.0.tm.html punkshell_module_punk::assertion} . {rest doc/files/punk/_module_rest-0.1.0.tm.html punkshell_module_punk::rest} . {module doc/files/_module_poshinfo-0.1.0.tm.html punkshell_module_poshinfo} . {filesystem doc/files/punk/_module_island-0.1.0.tm.html punkshell_module_punk::island} . {module doc/files/punk/_module_sshrun-0.1.0.tm.html punkshell_module_punk::sshrun} . {module doc/files/punk/_module_island-0.1.0.tm.html punkshell_module_punk::island} . {parse doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args} . {repl doc/files/project_intro.html punkshell__project_intro} . {configuration doc/files/_module_tomlish-1.1.1.tm.html tomlish_module_tomlish} . {crossplatform doc/files/punk/_module_winlnk-0.1.0.tm.html punkshell_module_punk::winlnk} . {experimental doc/files/punk/_module_cesu-0.1.0.tm.html punkshell_module_punk::cesu} . {toml doc/files/_module_fauxlink-0.1.1.tm.html fauxlink_module_fauxlink} . {shortcut doc/files/_module_fauxlink-0.1.1.tm.html fauxlink_module_fauxlink} . {encoding doc/files/punk/_module_cesu-0.1.0.tm.html punkshell_module_punk::cesu} . {filesystem doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::path} . {debug doc/files/punk/_module_assertion-0.1.0.tm.html punkshell_module_punk::assertion} . {fileformat doc/files/punk/_module_zip-0.1.1.tm.html punkshell_module_punk::zip} . {theme doc/files/_module_poshinfo-0.1.0.tm.html punkshell_module_poshinfo} . {module doc/files/punk/_module_encmime-0.1.0.tm.html punkshell_module_punk::encmime} . {console doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi} . {punk doc/files/main.html punkshell} . {parse doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline} . {module doc/files/punk/_module_packagepreference-0.1.0.tm.html punkshell_module_punk::packagepreference} . {module doc/files/punk/_module_aliascore-0.1.0.tm.html punkshell_module_punk::aliascore} . {module doc/files/punk/_module_blockletter-0.1.0.tm.html punkshell_module_punk::blockletter} . {module doc/files/punk/_module_lib-0.1.1.tm.html punkshell_module_punk::lib} . {faux doc/files/_module_fauxlink-0.1.1.tm.html fauxlink_module_fauxlink} .} 66 {assertion assertion fileformat fileformat assert assert POSH posh debug debug theme theme windows windows proc proc filesystem filesystem layout layout fake fake datastructure datastructure utility utility wcswidth wcswidth ssh ssh rest rest scriptwrap scriptwrap changelog changelog prompt prompt launcher launcher terminal terminal path path args args crossplatform crossplatform unofficial unofficial cesu cesu configuration configuration table table http http file file encodings encodings compatibility compatibility alias alias package package parsing parsing colour colour {prompt theme} prompt_theme experimental experimental shell shell capability capability parse parse commandset commandset console console repl repl frame frame toml toml telnet telnet shortcut shortcut text text lnk lnk arguments arguments BOM bom encoding encoding interp interp protocol protocol zip zip ansi ansi trie trie faux faux module module punk punk plugin plugin string string unicode unicode lib lib symlink symlink} \ No newline at end of file diff --git a/src/embedded/www/.toc b/src/embedded/www/.toc index d029b874..4bdba856 100644 --- a/src/embedded/www/.toc +++ b/src/embedded/www/.toc @@ -1 +1 @@ -doc {doc/toc {{doc/files/punk/_module_cap-0.1.0.tm.html punkshell_module_punk::cap {capability provider and handler plugin system}} {doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi {Ansi string functions}} {doc/files/punk/repl/_module_codethread-0.1.0.tm.html shellspy_module_punk::repl::codethread {Module API}} {doc/files/punk/nav/_module_fs-0.1.0.tm.html shellspy_module_punk::nav::fs {Module API}} {doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::path {Filesystem path utilities}} {doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args {args parsing}} {doc/files/project_changes.html punkshell__project_changes {punkshell Changes}} {doc/files/punk/_module_encmime-0.1.0.tm.html punkshell_module_punk::encmime {mime encodings related subset of tcllib mime}} {doc/files/punk/_module_char-0.1.0.tm.html punkshell_module_punk::char {character-set and unicode utilities}} {doc/files/_module_modpod-0.1.0.tm.html modpod_module_modpod {Module API}} {doc/files/punk/_module_uc-0.1.0.tm.html shellspy_module_punk::uc {Module API}} {doc/files/punk/_module_lib-0.1.1.tm.html punkshell_module_punk::lib {punk general utility functions}} {doc/files/punk/_module_assertion-0.1.0.tm.html shellspy_module_punk::assertion {assertion alternative to control::assert}} {doc/files/project_intro.html punkshell__project_intro {Introduction to punkshell}} {doc/files/punk/_module_experiment-0.1.0.tm.html shellspy_module_punk::experiment {Module API}} {doc/files/_module_poshinfo-0.1.0.tm.html shellspy_module_poshinfo {Module API}} {doc/files/_module_argparsingtest-0.1.0.tm.html shellspy_module_argparsingtest {Module API}} {doc/files/_module_overtype-1.6.3.tm.html overtype_module_overtype {overtype text layout - ansi aware}} {doc/files/punk/_module_sshrun-0.1.0.tm.html shellspy_module_punk::sshrun {Tcl procedures to execute tcl scripts in remote hosts}} {doc/files/punk/_module_packagepreference-0.1.0.tm.html shellspy_module_punk::packagepreference {Module API}} {doc/files/punk/_module_island-0.1.0.tm.html shellspy_module_punk::island {filesystem islands for safe interps}} {doc/files/punk/_module_aliascore-0.1.0.tm.html shellspy_module_punk::aliascore {Module API}} {doc/files/main.html punkshell {punkshell - Core}} {doc/files/_module_overtype-1.6.4.tm.html overtype_module_overtype {overtype text layout - ansi aware}} {doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::console {punk console}} {doc/files/_module_textblock-0.1.1.tm.html punkshell_module_textblock {punk textblock functions}} {doc/files/_module_overtype-1.6.5.tm.html overtype_module_overtype {overtype text layout - ansi aware}} {doc/files/punk/_module_flib-0.1.0.tm.html punkshell_module_punk::flib {flib experimental}} {doc/files/_module_tomlish-1.1.1.tm.html tomlish_module_tomlish {Module API}} {doc/files/punk/mix/commandset/_module_project-0.1.0.tm.html punkshell_module_punk::mix::commandset::project {dec commandset - project}} {doc/files/punk/_module_basictelnet-0.1.0.tm.html shellspy_module_punk::basictelnet {basic telnet client - DKF/Wiki}} {doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline {file line-handling utilities}} {doc/files/punk/_module_zip-0.1.0.tm.html shellspy_module_punk::zip {Module API}}}} \ No newline at end of file +doc {doc/toc {{doc/files/punk/_module_zip-0.1.1.tm.html punkshell_module_punk::zip {Module API}} {doc/files/punk/_module_trie-0.1.0.tm.html punkshell_module_punk::trie {punk::trie API}} {doc/files/punk/_module_cap-0.1.0.tm.html punkshell_module_punk::cap {capability provider and handler plugin system}} {doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::ansi {Ansi string functions}} {doc/files/punk/repl/_module_codethread-0.1.0.tm.html shellspy_module_punk::repl::codethread {Module repl codethread}} {doc/files/punk/nav/_module_fs-0.1.0.tm.html shellspy_module_punk::nav::fs {punk::nav::fs console filesystem navigation}} {doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::path {Filesystem path utilities}} {doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::args {args parsing}} {doc/files/project_changes.html punkshell__project_changes {punkshell Changes}} {doc/files/punk/_module_encmime-0.1.0.tm.html punkshell_module_punk::encmime {mime encodings related subset of tcllib mime}} {doc/files/punk/_module_char-0.1.0.tm.html punkshell_module_punk::char {character-set and unicode utilities}} {doc/files/punk/_module_uc-0.1.0.tm.html punkshell_module_punk::uc {Module API}} {doc/files/punk/_module_lib-0.1.1.tm.html punkshell_module_punk::lib {punk general utility functions}} {doc/files/punk/_module_cesu-0.1.0.tm.html punkshell_module_punk::cesu {CESU compatibility ehcoding scheme for utf-16: 8-Bit (CESU-8) ??}} {doc/files/punk/_module_assertion-0.1.0.tm.html punkshell_module_punk::assertion {assertion alternative to control::assert}} {doc/files/project_intro.html punkshell__project_intro {Introduction to punkshell}} {doc/files/_module_modpod-0.1.2.tm.html modpod_module_modpod {Module API}} {doc/files/punk/_module_experiment-0.1.0.tm.html punkshell_module_punk::experiment {Module API}} {doc/files/_module_poshinfo-0.1.0.tm.html punkshell_module_poshinfo {poshinfo prompt theme tool}} {doc/files/_module_argparsingtest-0.1.0.tm.html punkshell_module_argparsingtest {Module API}} {doc/files/punk/_module_sshrun-0.1.0.tm.html punkshell_module_punk::sshrun {Tcl procedures to execute tcl scripts in remote hosts}} {doc/files/punk/_module_packagepreference-0.1.0.tm.html punkshell_module_punk::packagepreference {punkshell package/module loading}} {doc/files/punk/_module_island-0.1.0.tm.html punkshell_module_punk::island {filesystem islands for safe interps}} {doc/files/punk/_module_aliascore-0.1.0.tm.html punkshell_module_punk::aliascore {punkshell command aliases}} {doc/files/main.html punkshell {punkshell - Core}} {doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::console {punk console}} {doc/files/_module_textblock-0.1.1.tm.html punkshell_module_textblock {punk textblock functions}} {doc/files/_module_overtype-1.6.5.tm.html overtype_module_overtype {overtype text layout - ansi aware}} {doc/files/punk/_module_flib-0.1.0.tm.html punkshell_module_punk::flib {flib experimental}} {doc/files/_module_tomlish-1.1.1.tm.html tomlish_module_tomlish {tomlish toml parser}} {doc/files/_module_textblock-0.1.2.tm.html punkshell_module_textblock {punk textblock functions}} {doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.html punkshell_module_scriptwrap {scriptwrap polyglot tool}} {doc/files/punk/mix/commandset/_module_project-0.1.0.tm.html punkshell_module_punk::mix::commandset::project {dec commandset - project}} {doc/files/punk/_module_rest-0.1.0.tm.html punkshell_module_punk::rest punk::rest} {doc/files/punk/_module_basictelnet-0.1.0.tm.html punkshell::basictelnet {basic telnet client - DKF/Wiki}} {doc/files/_module_fauxlink-0.1.1.tm.html fauxlink_module_fauxlink {faux link application shortcuts}} {doc/files/punk/_module_fileline-0.1.0.tm.html punkshell_module_punk::fileline {file line-handling utilities}} {doc/files/punk/_module_zip-0.1.0.tm.html shellspy_module_punk::zip {Module API}} {doc/files/punk/_module_winlnk-0.1.0.tm.html punkshell_module_punk::winlnk {windows shortcut .lnk library}} {doc/files/punk/_module_blockletter-0.1.0.tm.html punkshell_module_punk::blockletter {punk::blockletter frame-based large lettering test/logo}}}} \ No newline at end of file diff --git a/src/embedded/www/.xrf b/src/embedded/www/.xrf index d0a676cd..3d75e61f 100644 --- a/src/embedded/www/.xrf +++ b/src/embedded/www/.xrf @@ -1 +1 @@ -punkshell_module_punk::path(0) doc/files/punk/_module_path-0.1.0.tm.html sa,shellspy_module_punk::island doc/files/punk/_module_island-0.1.0.tm.html sa,punkshell_module_punk::mix::commandset::project(0) doc/files/punk/mix/commandset/_module_project-0.1.0.tm.html kw,lib {index.html lib} shellspy_module_punk::packagepreference(0) doc/files/punk/_module_packagepreference-0.1.0.tm.html debug {index.html debug} punkshell_module_punk::console(0) doc/files/punk/_module_console-0.1.1.tm.html {basic telnet client - DKF/Wiki} doc/files/punk/_module_basictelnet-0.1.0.tm.html shellspy_module_punk::island doc/files/punk/_module_island-0.1.0.tm.html sa,punkshell_module_punk::fileline(0) doc/files/punk/_module_fileline-0.1.0.tm.html filesystem {index.html filesystem} sa,punkshell_module_punk::cap doc/files/punk/_module_cap-0.1.0.tm.html kw,interp {index.html interp} sa,punkshell_module_punk::cap(0) doc/files/punk/_module_cap-0.1.0.tm.html sa,shellspy_module_punk::assertion doc/files/punk/_module_assertion-0.1.0.tm.html kw,terminal {index.html terminal} kw,path {index.html path} utility {index.html utility} sa,shellspy_module_argparsingtest doc/files/_module_argparsingtest-0.1.0.tm.html kw,assert {index.html assert} changelog {index.html changelog} shellspy_module_punk::uc(0) doc/files/punk/_module_uc-0.1.0.tm.html path {index.html path} shellspy_module_punk::basictelnet doc/files/punk/_module_basictelnet-0.1.0.tm.html sa,punkshell_module_punk::path doc/files/punk/_module_path-0.1.0.tm.html sa,shellspy_module_punk::uc doc/files/punk/_module_uc-0.1.0.tm.html sa,punkshell_module_punk::lib doc/files/punk/_module_lib-0.1.1.tm.html sa,punkshell_module_punk::mix::commandset::project doc/files/punk/mix/commandset/_module_project-0.1.0.tm.html shellspy_module_punk::aliascore(0) doc/files/punk/_module_aliascore-0.1.0.tm.html sa,shellspy_module_argparsingtest(0) doc/files/_module_argparsingtest-0.1.0.tm.html sa,punkshell_module_punk::ansi(0) doc/files/punk/_module_ansi-0.1.1.tm.html {Module API} doc/files/punk/_module_zip-0.1.0.tm.html punkshell_module_punk::args doc/files/punk/_module_args-0.1.0.tm.html shellspy_module_punk::uc doc/files/punk/_module_uc-0.1.0.tm.html capability {index.html capability} punkshell_module_punk::encmime(0) doc/files/punk/_module_encmime-0.1.0.tm.html parse {index.html parse} sa,punkshell_module_punk::lib(0) doc/files/punk/_module_lib-0.1.1.tm.html {punkshell - Core} doc/files/main.html {capability provider and handler plugin system} doc/files/punk/_module_cap-0.1.0.tm.html sa,punkshell_module_punk::encmime doc/files/punk/_module_encmime-0.1.0.tm.html shellspy_module_punk::experiment(0) doc/files/punk/_module_experiment-0.1.0.tm.html punkshell_module_punk::fileline doc/files/punk/_module_fileline-0.1.0.tm.html kw,punk {index.html punk} tomlish_module_tomlish(0) doc/files/_module_tomlish-1.1.1.tm.html {Filesystem path utilities} doc/files/punk/_module_path-0.1.0.tm.html arguments {index.html arguments} interp {index.html interp} sa,shellspy_module_punk::repl::codethread doc/files/punk/repl/_module_codethread-0.1.0.tm.html punk {index.html punk} lib {index.html lib} punkshell_module_punk::args(0) doc/files/punk/_module_args-0.1.0.tm.html sa,punkshell_module_textblock doc/files/_module_textblock-0.1.1.tm.html assert {index.html assert} kw,proc {index.html proc} {flib experimental} doc/files/punk/_module_flib-0.1.0.tm.html punkshell_module_punk::ansi doc/files/punk/_module_ansi-0.1.1.tm.html kw,encodings {index.html encodings} shellspy_module_punk::assertion(0) doc/files/punk/_module_assertion-0.1.0.tm.html sa,shellspy_module_punk::nav::fs doc/files/punk/nav/_module_fs-0.1.0.tm.html sa,tomlish_module_tomlish doc/files/_module_tomlish-1.1.1.tm.html proc {index.html proc} sa,punkshell doc/files/main.html kw,shell {index.html shell} {punk console} doc/files/punk/_module_console-0.1.1.tm.html sa,punkshell__project_changes(n) doc/files/project_changes.html sa,punkshell_module_punk::flib(0) doc/files/punk/_module_flib-0.1.0.tm.html sa,shellspy_module_punk::uc(0) doc/files/punk/_module_uc-0.1.0.tm.html kw,args {index.html args} punkshell_module_punk::cap(0) doc/files/punk/_module_cap-0.1.0.tm.html terminal {index.html terminal} sa,shellspy_module_punk::repl::codethread(0) doc/files/punk/repl/_module_codethread-0.1.0.tm.html args {index.html args} punkshell_module_punk::console doc/files/punk/_module_console-0.1.1.tm.html sa,punkshell_module_punk::args doc/files/punk/_module_args-0.1.0.tm.html punkshell__project_changes doc/files/project_changes.html sa,punkshell_module_punk::char(0) doc/files/punk/_module_char-0.1.0.tm.html sa,shellspy_module_punk::experiment doc/files/punk/_module_experiment-0.1.0.tm.html shellspy_module_punk::sshrun(0) doc/files/punk/_module_sshrun-0.1.0.tm.html experimental {index.html experimental} shellspy_module_punk::experiment doc/files/punk/_module_experiment-0.1.0.tm.html sa,shellspy_module_punk::experiment(0) doc/files/punk/_module_experiment-0.1.0.tm.html sa,punkshell_module_punk::fileline doc/files/punk/_module_fileline-0.1.0.tm.html sa,shellspy_module_punk::zip doc/files/punk/_module_zip-0.1.0.tm.html kw,encoding {index.html encoding} shellspy_module_argparsingtest(0) doc/files/_module_argparsingtest-0.1.0.tm.html kw,ansi {index.html ansi} sa,punkshell_module_textblock(0) doc/files/_module_textblock-0.1.1.tm.html console {index.html console} punkshell_module_punk::lib(0) doc/files/punk/_module_lib-0.1.1.tm.html sa,punkshell__project_intro doc/files/project_intro.html sa,punkshell_module_punk::path(0) doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::char doc/files/punk/_module_char-0.1.0.tm.html ansi {index.html ansi} punkshell__project_intro(n) doc/files/project_intro.html punkshell__project_intro doc/files/project_intro.html sa,shellspy_module_punk::packagepreference(0) doc/files/punk/_module_packagepreference-0.1.0.tm.html kw,changelog {index.html changelog} sa,punkshell_module_punk::ansi doc/files/punk/_module_ansi-0.1.1.tm.html assertion {index.html assertion} punkshell_module_punk::flib doc/files/punk/_module_flib-0.1.0.tm.html shellspy_module_punk::island(0) doc/files/punk/_module_island-0.1.0.tm.html {punk general utility functions} doc/files/punk/_module_lib-0.1.1.tm.html shellspy_module_punk::packagepreference doc/files/punk/_module_packagepreference-0.1.0.tm.html punkshell_module_punk::mix::commandset::project(0) doc/files/punk/mix/commandset/_module_project-0.1.0.tm.html shellspy_module_poshinfo(0) doc/files/_module_poshinfo-0.1.0.tm.html shellspy_module_punk::nav::fs doc/files/punk/nav/_module_fs-0.1.0.tm.html kw,module {index.html module} punkshell_module_punk::fileline(0) doc/files/punk/_module_fileline-0.1.0.tm.html kw,plugin {index.html plugin} punkshell doc/files/main.html punkshell_module_punk::cap doc/files/punk/_module_cap-0.1.0.tm.html sa,shellspy_module_punk::basictelnet(0) doc/files/punk/_module_basictelnet-0.1.0.tm.html punkshell__project_changes(n) doc/files/project_changes.html kw,utility {index.html utility} kw,ssh {index.html ssh} kw,arguments {index.html arguments} shellspy_module_argparsingtest doc/files/_module_argparsingtest-0.1.0.tm.html sa,shellspy_module_punk::sshrun(0) doc/files/punk/_module_sshrun-0.1.0.tm.html sa,shellspy_module_punk::aliascore(0) doc/files/punk/_module_aliascore-0.1.0.tm.html shellspy_module_punk::basictelnet(0) doc/files/punk/_module_basictelnet-0.1.0.tm.html kw,filesystem {index.html filesystem} shellspy_module_punk::repl::codethread(0) doc/files/punk/repl/_module_codethread-0.1.0.tm.html sa,overtype_module_overtype doc/files/_module_overtype-1.6.5.tm.html shell {index.html shell} {assertion alternative to control::assert} doc/files/punk/_module_assertion-0.1.0.tm.html punkshell_module_punk::lib doc/files/punk/_module_lib-0.1.1.tm.html shellspy_module_punk::aliascore doc/files/punk/_module_aliascore-0.1.0.tm.html kw,debug {index.html debug} {punk textblock functions} doc/files/_module_textblock-0.1.1.tm.html punkshell_module_punk::ansi(0) doc/files/punk/_module_ansi-0.1.1.tm.html overtype_module_overtype doc/files/_module_overtype-1.6.5.tm.html overtype_module_overtype(0) doc/files/_module_overtype-1.6.5.tm.html sa,punkshell_module_punk::char doc/files/punk/_module_char-0.1.0.tm.html sa,punkshell__project_intro(n) doc/files/project_intro.html shellspy_module_punk::zip doc/files/punk/_module_zip-0.1.0.tm.html sa,shellspy_module_poshinfo doc/files/_module_poshinfo-0.1.0.tm.html encoding {index.html encoding} sa,punkshell_module_punk::flib doc/files/punk/_module_flib-0.1.0.tm.html sa,punkshell_module_punk::args(0) doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::encmime doc/files/punk/_module_encmime-0.1.0.tm.html modpod_module_modpod(0) doc/files/_module_modpod-0.1.0.tm.html punkshell_module_textblock(0) doc/files/_module_textblock-0.1.1.tm.html kw,BOM {index.html bom} shellspy_module_poshinfo doc/files/_module_poshinfo-0.1.0.tm.html sa,shellspy_module_punk::island(0) doc/files/punk/_module_island-0.1.0.tm.html {file line-handling utilities} doc/files/punk/_module_fileline-0.1.0.tm.html module {index.html module} plugin {index.html plugin} sa,punkshell_module_punk::console(0) doc/files/punk/_module_console-0.1.1.tm.html kw,capability {index.html capability} sa,modpod_module_modpod doc/files/_module_modpod-0.1.0.tm.html sa,shellspy_module_punk::assertion(0) doc/files/punk/_module_assertion-0.1.0.tm.html shellspy_module_punk::repl::codethread doc/files/punk/repl/_module_codethread-0.1.0.tm.html sa,shellspy_module_punk::packagepreference doc/files/punk/_module_packagepreference-0.1.0.tm.html {punkshell Changes} doc/files/project_changes.html sa,shellspy_module_poshinfo(0) doc/files/_module_poshinfo-0.1.0.tm.html modpod_module_modpod doc/files/_module_modpod-0.1.0.tm.html punkshell_module_textblock doc/files/_module_textblock-0.1.1.tm.html {Introduction to punkshell} doc/files/project_intro.html sa,punkshell(n) doc/files/main.html {mime encodings related subset of tcllib mime} doc/files/punk/_module_encmime-0.1.0.tm.html kw,parse {index.html parse} tomlish_module_tomlish doc/files/_module_tomlish-1.1.1.tm.html punkshell(n) doc/files/main.html kw,string {index.html string} kw,file {index.html file} ssh {index.html ssh} sa,punkshell_module_punk::console doc/files/punk/_module_console-0.1.1.tm.html sa,shellspy_module_punk::basictelnet doc/files/punk/_module_basictelnet-0.1.0.tm.html shellspy_module_punk::assertion doc/files/punk/_module_assertion-0.1.0.tm.html punkshell_module_punk::flib(0) doc/files/punk/_module_flib-0.1.0.tm.html sa,punkshell__project_changes doc/files/project_changes.html {dec commandset - project} doc/files/punk/mix/commandset/_module_project-0.1.0.tm.html kw,experimental {index.html experimental} file {index.html file} {args parsing} doc/files/punk/_module_args-0.1.0.tm.html encodings {index.html encodings} {Ansi string functions} doc/files/punk/_module_ansi-0.1.1.tm.html sa,punkshell_module_punk::encmime(0) doc/files/punk/_module_encmime-0.1.0.tm.html sa,shellspy_module_punk::sshrun doc/files/punk/_module_sshrun-0.1.0.tm.html sa,shellspy_module_punk::aliascore doc/files/punk/_module_aliascore-0.1.0.tm.html sa,shellspy_module_punk::zip(0) doc/files/punk/_module_zip-0.1.0.tm.html kw,assertion {index.html assertion} punkshell_module_punk::path doc/files/punk/_module_path-0.1.0.tm.html sa,overtype_module_overtype(0) doc/files/_module_overtype-1.6.5.tm.html {overtype text layout - ansi aware} doc/files/_module_overtype-1.6.5.tm.html kw,repl {index.html repl} punkshell_module_punk::char(0) doc/files/punk/_module_char-0.1.0.tm.html kw,text {index.html text} {Tcl procedures to execute tcl scripts in remote hosts} doc/files/punk/_module_sshrun-0.1.0.tm.html punkshell_module_punk::mix::commandset::project doc/files/punk/mix/commandset/_module_project-0.1.0.tm.html sa,shellspy_module_punk::nav::fs(0) doc/files/punk/nav/_module_fs-0.1.0.tm.html shellspy_module_punk::sshrun doc/files/punk/_module_sshrun-0.1.0.tm.html sa,tomlish_module_tomlish(0) doc/files/_module_tomlish-1.1.1.tm.html {filesystem islands for safe interps} doc/files/punk/_module_island-0.1.0.tm.html shellspy_module_punk::zip(0) doc/files/punk/_module_zip-0.1.0.tm.html sa,modpod_module_modpod(0) doc/files/_module_modpod-0.1.0.tm.html repl {index.html repl} shellspy_module_punk::nav::fs(0) doc/files/punk/nav/_module_fs-0.1.0.tm.html text {index.html text} BOM {index.html bom} kw,console {index.html console} {character-set and unicode utilities} doc/files/punk/_module_char-0.1.0.tm.html string {index.html string} \ No newline at end of file +sa,punkshell_module_punk::trie(0) doc/files/punk/_module_trie-0.1.0.tm.html punkshell_module_scriptwrap doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.html sa,fauxlink_module_fauxlink(0) doc/files/_module_fauxlink-0.1.1.tm.html fileformat {index.html fileformat} punkshell_module_punk::path(0) doc/files/punk/_module_path-0.1.0.tm.html POSH {index.html posh} sa,punkshell_module_punk::assertion(0) doc/files/punk/_module_assertion-0.1.0.tm.html sa,punkshell_module_punk::experiment doc/files/punk/_module_experiment-0.1.0.tm.html sa,punkshell_module_punk::mix::commandset::project(0) doc/files/punk/mix/commandset/_module_project-0.1.0.tm.html kw,lib {index.html lib} kw,configuration {index.html configuration} kw,table {index.html table} debug {index.html debug} punkshell_module_punk::packagepreference(0) doc/files/punk/_module_packagepreference-0.1.0.tm.html punkshell_module_punk::console(0) doc/files/punk/_module_console-0.1.1.tm.html kw,compatibility {index.html compatibility} {basic telnet client - DKF/Wiki} doc/files/punk/_module_basictelnet-0.1.0.tm.html windows {index.html windows} kw,wcswidth {index.html wcswidth} kw,rest {index.html rest} sa,punkshell_module_punk::fileline(0) doc/files/punk/_module_fileline-0.1.0.tm.html filesystem {index.html filesystem} sa,punkshell_module_punk::cap doc/files/punk/_module_cap-0.1.0.tm.html kw,interp {index.html interp} sa,punkshell_module_punk::cap(0) doc/files/punk/_module_cap-0.1.0.tm.html kw,terminal {index.html terminal} punkshell_module_punk::rest(0) doc/files/punk/_module_rest-0.1.0.tm.html kw,path {index.html path} utility {index.html utility} rest {index.html rest} sa,punkshell_module_argparsingtest doc/files/_module_argparsingtest-0.1.0.tm.html kw,assert {index.html assert} changelog {index.html changelog} sa,punkshell_module_punk::rest doc/files/punk/_module_rest-0.1.0.tm.html path {index.html path} punkshell_module_poshinfo doc/files/_module_poshinfo-0.1.0.tm.html unofficial {index.html unofficial} sa,punkshell_module_punk::path doc/files/punk/_module_path-0.1.0.tm.html sa,punkshell_module_punk::lib doc/files/punk/_module_lib-0.1.1.tm.html {CESU compatibility ehcoding scheme for utf-16: 8-Bit (CESU-8) ??} doc/files/punk/_module_cesu-0.1.0.tm.html sa,punkshell_module_punk::assertion doc/files/punk/_module_assertion-0.1.0.tm.html sa,punkshell_module_punk::mix::commandset::project doc/files/punk/mix/commandset/_module_project-0.1.0.tm.html package {index.html package} parsing {index.html parsing} sa,punkshell_module_punk::uc(0) doc/files/punk/_module_uc-0.1.0.tm.html {faux link application shortcuts} doc/files/_module_fauxlink-0.1.1.tm.html punkshell_module_punk::zip doc/files/punk/_module_zip-0.1.1.tm.html {Module API} doc/files/punk/_module_zip-0.1.0.tm.html {punk::trie API} doc/files/punk/_module_trie-0.1.0.tm.html sa,punkshell_module_punk::ansi(0) doc/files/punk/_module_ansi-0.1.1.tm.html punkshell_module_punk::args doc/files/punk/_module_args-0.1.0.tm.html {poshinfo prompt theme tool} doc/files/_module_poshinfo-0.1.0.tm.html capability {index.html capability} kw,shortcut {index.html shortcut} punkshell_module_punk::encmime(0) doc/files/punk/_module_encmime-0.1.0.tm.html parse {index.html parse} sa,punkshell_module_punk::lib(0) doc/files/punk/_module_lib-0.1.1.tm.html punkshell_module_punk::cesu doc/files/punk/_module_cesu-0.1.0.tm.html punkshell_module_punk::assertion doc/files/punk/_module_assertion-0.1.0.tm.html {punkshell - Core} doc/files/main.html punkshell_module_punk::uc(0) doc/files/punk/_module_uc-0.1.0.tm.html {capability provider and handler plugin system} doc/files/punk/_module_cap-0.1.0.tm.html sa,punkshell_module_punk::encmime doc/files/punk/_module_encmime-0.1.0.tm.html punkshell_module_punk::fileline doc/files/punk/_module_fileline-0.1.0.tm.html kw,punk {index.html punk} tomlish_module_tomlish(0) doc/files/_module_tomlish-1.1.1.tm.html {Filesystem path utilities} doc/files/punk/_module_path-0.1.0.tm.html arguments {index.html arguments} {punkshell command aliases} doc/files/punk/_module_aliascore-0.1.0.tm.html punk::rest doc/files/punk/_module_rest-0.1.0.tm.html sa,punkshell_module_scriptwrap doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.html kw,colour {index.html colour} protocol {index.html protocol} interp {index.html interp} kw,lnk {index.html lnk} sa,shellspy_module_punk::repl::codethread doc/files/punk/repl/_module_codethread-0.1.0.tm.html punk {index.html punk} lib {index.html lib} sa,punkshell_module_punk::packagepreference(0) doc/files/punk/_module_packagepreference-0.1.0.tm.html punkshell_module_punk::args(0) doc/files/punk/_module_args-0.1.0.tm.html sa,punkshell_module_textblock doc/files/_module_textblock-0.1.2.tm.html assert {index.html assert} kw,proc {index.html proc} {flib experimental} doc/files/punk/_module_flib-0.1.0.tm.html sa,punkshell_module_punk::uc doc/files/punk/_module_uc-0.1.0.tm.html sa,punkshell_module_punk::cesu(0) doc/files/punk/_module_cesu-0.1.0.tm.html kw,fake {index.html fake} kw,symlink {index.html symlink} kw,unicode {index.html unicode} punkshell_module_punk::ansi doc/files/punk/_module_ansi-0.1.1.tm.html sa,punkshell_module_punk::sshrun doc/files/punk/_module_sshrun-0.1.0.tm.html punkshell_module_punk::blockletter doc/files/punk/_module_blockletter-0.1.0.tm.html sa,punkshell_module_punk::zip(0) doc/files/punk/_module_zip-0.1.1.tm.html punkshell_module_punk::trie doc/files/punk/_module_trie-0.1.0.tm.html sa,punkshell::basictelnet doc/files/punk/_module_basictelnet-0.1.0.tm.html kw,encodings {index.html encodings} kw,alias {index.html alias} kw,telnet {index.html telnet} theme {index.html theme} sa,shellspy_module_punk::nav::fs doc/files/punk/nav/_module_fs-0.1.0.tm.html sa,tomlish_module_tomlish doc/files/_module_tomlish-1.1.1.tm.html proc {index.html proc} punkshell_module_punk::experiment doc/files/punk/_module_experiment-0.1.0.tm.html sa,punkshell doc/files/main.html kw,shell {index.html shell} fake {index.html fake} kw,launcher {index.html launcher} {punk console} doc/files/punk/_module_console-0.1.1.tm.html sa,punkshell__project_changes(n) doc/files/project_changes.html sa,punkshell_module_punk::flib(0) doc/files/punk/_module_flib-0.1.0.tm.html datastructure {index.html datastructure} kw,args {index.html args} {punk::nav::fs console filesystem navigation} doc/files/punk/nav/_module_fs-0.1.0.tm.html {punk::blockletter frame-based large lettering test/logo} doc/files/punk/_module_blockletter-0.1.0.tm.html wcswidth {index.html wcswidth} kw,http {index.html http} kw,cesu {index.html cesu} sa,punkshell_module_punk::packagepreference doc/files/punk/_module_packagepreference-0.1.0.tm.html scriptwrap {index.html scriptwrap} punkshell_module_punk::cap(0) doc/files/punk/_module_cap-0.1.0.tm.html kw,frame {index.html frame} punkshell_module_scriptwrap(0) doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.html terminal {index.html terminal} sa,shellspy_module_punk::repl::codethread(0) doc/files/punk/repl/_module_codethread-0.1.0.tm.html args {index.html args} punkshell_module_punk::packagepreference doc/files/punk/_module_packagepreference-0.1.0.tm.html punkshell_module_punk::console doc/files/punk/_module_console-0.1.1.tm.html http {index.html http} cesu {index.html cesu} table {index.html table} sa,punkshell_module_punk::args doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_argparsingtest(0) doc/files/_module_argparsingtest-0.1.0.tm.html punkshell__project_changes doc/files/project_changes.html sa,punkshell_module_punk::char(0) doc/files/punk/_module_char-0.1.0.tm.html sa,punkshell_module_punk::cesu doc/files/punk/_module_cesu-0.1.0.tm.html kw,layout {index.html layout} colour {index.html colour} {prompt theme} {index.html prompt_theme} experimental {index.html experimental} sa,punkshell_module_punk::island doc/files/punk/_module_island-0.1.0.tm.html sa,punkshell_module_punk::blockletter(0) doc/files/punk/_module_blockletter-0.1.0.tm.html sa,punkshell_module_punk::fileline doc/files/punk/_module_fileline-0.1.0.tm.html sa,shellspy_module_punk::zip doc/files/punk/_module_zip-0.1.0.tm.html kw,encoding {index.html encoding} {windows shortcut .lnk library} doc/files/punk/_module_winlnk-0.1.0.tm.html kw,prompt {index.html prompt} kw,ansi {index.html ansi} kw,trie {index.html trie} sa,punkshell_module_textblock(0) doc/files/_module_textblock-0.1.2.tm.html console {index.html console} punkshell_module_punk::lib(0) doc/files/punk/_module_lib-0.1.1.tm.html shortcut {index.html shortcut} telnet {index.html telnet} lnk {index.html lnk} sa,punkshell__project_intro doc/files/project_intro.html kw,datastructure {index.html datastructure} sa,punkshell_module_punk::path(0) doc/files/punk/_module_path-0.1.0.tm.html punkshell_module_punk::char doc/files/punk/_module_char-0.1.0.tm.html ansi {index.html ansi} trie {index.html trie} punkshell__project_intro(n) doc/files/project_intro.html punkshell__project_intro doc/files/project_intro.html kw,changelog {index.html changelog} sa,punkshell_module_punk::ansi doc/files/punk/_module_ansi-0.1.1.tm.html sa,punkshell_module_punk::trie doc/files/punk/_module_trie-0.1.0.tm.html sa,fauxlink_module_fauxlink doc/files/_module_fauxlink-0.1.1.tm.html assertion {index.html assertion} punkshell_module_punk::flib doc/files/punk/_module_flib-0.1.0.tm.html kw,commandset {index.html commandset} kw,zip {index.html zip} fauxlink_module_fauxlink doc/files/_module_fauxlink-0.1.1.tm.html punkshell_module_punk::trie(0) doc/files/punk/_module_trie-0.1.0.tm.html {punk general utility functions} doc/files/punk/_module_lib-0.1.1.tm.html {tomlish toml parser} doc/files/_module_tomlish-1.1.1.tm.html sa,punkshell::basictelnet(0) doc/files/punk/_module_basictelnet-0.1.0.tm.html sa,punkshell_module_punk::rest(0) doc/files/punk/_module_rest-0.1.0.tm.html punkshell_module_punk::uc doc/files/punk/_module_uc-0.1.0.tm.html punkshell_module_punk::mix::commandset::project(0) doc/files/punk/mix/commandset/_module_project-0.1.0.tm.html layout {index.html layout} punkshell_module_punk::sshrun doc/files/punk/_module_sshrun-0.1.0.tm.html sa,punkshell_module_punk::winlnk doc/files/punk/_module_winlnk-0.1.0.tm.html punkshell_module_punk::zip(0) doc/files/punk/_module_zip-0.1.1.tm.html kw,windows {index.html windows} shellspy_module_punk::nav::fs doc/files/punk/nav/_module_fs-0.1.0.tm.html kw,module {index.html module} punkshell_module_punk::fileline(0) doc/files/punk/_module_fileline-0.1.0.tm.html kw,plugin {index.html plugin} punkshell doc/files/main.html kw,fileformat {index.html fileformat} punkshell_module_punk::cap doc/files/punk/_module_cap-0.1.0.tm.html sa,punkshell_module_poshinfo(0) doc/files/_module_poshinfo-0.1.0.tm.html punkshell__project_changes(n) doc/files/project_changes.html kw,utility {index.html utility} launcher {index.html launcher} prompt {index.html prompt} kw,ssh {index.html ssh} kw,arguments {index.html arguments} {punkshell package/module loading} doc/files/punk/_module_packagepreference-0.1.0.tm.html sa,punkshell_module_punk::zip doc/files/punk/_module_zip-0.1.1.tm.html crossplatform {index.html crossplatform} punkshell_module_poshinfo(0) doc/files/_module_poshinfo-0.1.0.tm.html alias {index.html alias} kw,filesystem {index.html filesystem} shellspy_module_punk::repl::codethread(0) doc/files/punk/repl/_module_codethread-0.1.0.tm.html punkshell_module_punk::aliascore(0) doc/files/punk/_module_aliascore-0.1.0.tm.html sa,overtype_module_overtype doc/files/_module_overtype-1.6.5.tm.html shell {index.html shell} {assertion alternative to control::assert} doc/files/punk/_module_assertion-0.1.0.tm.html kw,package {index.html package} kw,parsing {index.html parsing} kw,toml {index.html toml} punkshell_module_punk::lib doc/files/punk/_module_lib-0.1.1.tm.html kw,debug {index.html debug} punkshell_module_punk::island doc/files/punk/_module_island-0.1.0.tm.html {punk textblock functions} doc/files/_module_textblock-0.1.2.tm.html punkshell_module_punk::ansi(0) doc/files/punk/_module_ansi-0.1.1.tm.html sa,punkshell_module_punk::sshrun(0) doc/files/punk/_module_sshrun-0.1.0.tm.html overtype_module_overtype doc/files/_module_overtype-1.6.5.tm.html punkshell_module_punk::blockletter(0) doc/files/punk/_module_blockletter-0.1.0.tm.html overtype_module_overtype(0) doc/files/_module_overtype-1.6.5.tm.html sa,punkshell_module_punk::char doc/files/punk/_module_char-0.1.0.tm.html kw,faux {index.html faux} frame {index.html frame} toml {index.html toml} sa,punkshell__project_intro(n) doc/files/project_intro.html shellspy_module_punk::zip doc/files/punk/_module_zip-0.1.0.tm.html kw,unofficial {index.html unofficial} encoding {index.html encoding} punkshell_module_punk::sshrun(0) doc/files/punk/_module_sshrun-0.1.0.tm.html sa,punkshell_module_punk::winlnk(0) doc/files/punk/_module_winlnk-0.1.0.tm.html sa,punkshell_module_punk::flib doc/files/punk/_module_flib-0.1.0.tm.html sa,punkshell_module_punk::args(0) doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::encmime doc/files/punk/_module_encmime-0.1.0.tm.html modpod_module_modpod(0) doc/files/_module_modpod-0.1.2.tm.html punkshell_module_textblock(0) doc/files/_module_textblock-0.1.2.tm.html zip {index.html zip} {Module repl codethread} doc/files/punk/repl/_module_codethread-0.1.0.tm.html kw,BOM {index.html bom} faux {index.html faux} sa,punkshell_module_punk::experiment(0) doc/files/punk/_module_experiment-0.1.0.tm.html {file line-handling utilities} doc/files/punk/_module_fileline-0.1.0.tm.html module {index.html module} sa,punkshell_module_punk::blockletter doc/files/punk/_module_blockletter-0.1.0.tm.html symlink {index.html symlink} plugin {index.html plugin} unicode {index.html unicode} sa,punkshell_module_punk::console(0) doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::winlnk(0) doc/files/punk/_module_winlnk-0.1.0.tm.html kw,capability {index.html capability} sa,modpod_module_modpod doc/files/_module_modpod-0.1.2.tm.html shellspy_module_punk::repl::codethread doc/files/punk/repl/_module_codethread-0.1.0.tm.html kw,crossplatform {index.html crossplatform} punkshell_module_punk::experiment(0) doc/files/punk/_module_experiment-0.1.0.tm.html {punkshell Changes} doc/files/project_changes.html fauxlink_module_fauxlink(0) doc/files/_module_fauxlink-0.1.1.tm.html modpod_module_modpod doc/files/_module_modpod-0.1.2.tm.html punkshell_module_textblock doc/files/_module_textblock-0.1.2.tm.html {Introduction to punkshell} doc/files/project_intro.html punkshell_module_punk::cesu(0) doc/files/punk/_module_cesu-0.1.0.tm.html punkshell_module_punk::assertion(0) doc/files/punk/_module_assertion-0.1.0.tm.html sa,punkshell(n) doc/files/main.html {mime encodings related subset of tcllib mime} doc/files/punk/_module_encmime-0.1.0.tm.html sa,punkshell_module_punk::island(0) doc/files/punk/_module_island-0.1.0.tm.html punkshell::basictelnet doc/files/punk/_module_basictelnet-0.1.0.tm.html punkshell::basictelnet(0) doc/files/punk/_module_basictelnet-0.1.0.tm.html kw,parse {index.html parse} sa,punkshell_module_scriptwrap(0) doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.html tomlish_module_tomlish doc/files/_module_tomlish-1.1.1.tm.html punkshell(n) doc/files/main.html kw,string {index.html string} ssh {index.html ssh} kw,file {index.html file} sa,punkshell_module_punk::console doc/files/punk/_module_console-0.1.1.tm.html punkshell_module_punk::winlnk doc/files/punk/_module_winlnk-0.1.0.tm.html sa,punkshell_module_poshinfo doc/files/_module_poshinfo-0.1.0.tm.html punkshell_module_punk::island(0) doc/files/punk/_module_island-0.1.0.tm.html sa,punkshell_module_argparsingtest(0) doc/files/_module_argparsingtest-0.1.0.tm.html punkshell_module_punk::flib(0) doc/files/punk/_module_flib-0.1.0.tm.html sa,punkshell__project_changes doc/files/project_changes.html {dec commandset - project} doc/files/punk/mix/commandset/_module_project-0.1.0.tm.html {kw,prompt theme} {index.html prompt_theme} kw,experimental {index.html experimental} punkshell_module_argparsingtest doc/files/_module_argparsingtest-0.1.0.tm.html sa,punkshell_module_punk::aliascore(0) doc/files/punk/_module_aliascore-0.1.0.tm.html file {index.html file} configuration {index.html configuration} {args parsing} doc/files/punk/_module_args-0.1.0.tm.html punkshell_module_punk::rest doc/files/punk/_module_rest-0.1.0.tm.html encodings {index.html encodings} compatibility {index.html compatibility} {Ansi string functions} doc/files/punk/_module_ansi-0.1.1.tm.html sa,punkshell_module_punk::encmime(0) doc/files/punk/_module_encmime-0.1.0.tm.html sa,shellspy_module_punk::zip(0) doc/files/punk/_module_zip-0.1.0.tm.html kw,assertion {index.html assertion} {scriptwrap polyglot tool} doc/files/punk/mix/commandset/_module_scriptwrap-0.1.0.tm.html punkshell_module_punk::path doc/files/punk/_module_path-0.1.0.tm.html sa,overtype_module_overtype(0) doc/files/_module_overtype-1.6.5.tm.html {overtype text layout - ansi aware} doc/files/_module_overtype-1.6.5.tm.html kw,repl {index.html repl} punkshell_module_punk::char(0) doc/files/punk/_module_char-0.1.0.tm.html commandset {index.html commandset} kw,text {index.html text} {Tcl procedures to execute tcl scripts in remote hosts} doc/files/punk/_module_sshrun-0.1.0.tm.html punkshell_module_punk::mix::commandset::project doc/files/punk/mix/commandset/_module_project-0.1.0.tm.html sa,shellspy_module_punk::nav::fs(0) doc/files/punk/nav/_module_fs-0.1.0.tm.html sa,tomlish_module_tomlish(0) doc/files/_module_tomlish-1.1.1.tm.html kw,scriptwrap {index.html scriptwrap} {filesystem islands for safe interps} doc/files/punk/_module_island-0.1.0.tm.html shellspy_module_punk::zip(0) doc/files/punk/_module_zip-0.1.0.tm.html kw,protocol {index.html protocol} kw,theme {index.html theme} sa,modpod_module_modpod(0) doc/files/_module_modpod-0.1.2.tm.html repl {index.html repl} shellspy_module_punk::nav::fs(0) doc/files/punk/nav/_module_fs-0.1.0.tm.html text {index.html text} BOM {index.html bom} sa,punkshell_module_punk::aliascore doc/files/punk/_module_aliascore-0.1.0.tm.html kw,POSH {index.html posh} kw,console {index.html console} {character-set and unicode utilities} doc/files/punk/_module_char-0.1.0.tm.html punkshell_module_punk::aliascore doc/files/punk/_module_aliascore-0.1.0.tm.html string {index.html string} \ No newline at end of file diff --git a/src/embedded/www/doc/files/_module_argparsingtest-0.1.0.tm.html b/src/embedded/www/doc/files/_module_argparsingtest-0.1.0.tm.html index b3fde776..8c164d2c 100644 --- a/src/embedded/www/doc/files/_module_argparsingtest-0.1.0.tm.html +++ b/src/embedded/www/doc/files/_module_argparsingtest-0.1.0.tm.html @@ -1,5 +1,5 @@ -shellspy_module_argparsingtest - - +punkshell_module_argparsingtest - - + + + + +
[ + Main Table Of Contents +| Table Of Contents +| Keyword Index + ]
+
+

fauxlink_module_fauxlink(0) 0.1.1 doc "fauxlink .fxlnk"

+

Name

+

fauxlink_module_fauxlink - faux link application shortcuts

+
+ +

Synopsis

+
+
    +
  • package require fauxlink
    • +
+
+
+

Description

+

A cross platform shortcut/symlink alternative.

+

Unapologetically ugly - but practical in certain circumstances.

+

A solution is required for application-driven filesystem links that survives cross platform moves as well as

+

archiving and packaging systems.

+

The target is specified in a minimally-encoded form in the filename itself - but still human readable.

+

format of name <nominalname>#<encodedtarget>.fxlnk

+

where <nominalname> can be empty - then the effective nominal name is the tail of the <encodedtarget>

+

The + symbol substitutes for forward-slashes.

+

Other chars can be encoded using url-like encoding - (but only up to %7E !)

+

We deliberately treat higher % sequences literally.

+

This means actual uri::urn encoded unicode sequences (e.g %E2%99%A5 [heart]) can remain literal for linking to urls.

+

e.g if an actual + or # is required in a filename or path segment they can be encoded as %2B & %23

+

e.g a link to a file file#A.txt in parent dir could be:

+

file%23A.txt#..+file%23A.txt.fxlnk

+

or equivalently (but obviously affecting sorting) #..+file%23A.txt.fxlnk

+

The <nominalname> can be unrelated to the actual target

+

e.g datafile.dat#..+file%23A.txt.fxlnk

+

This system has no filesystem support - and must be completely application driven.

+

This can be useful for example in application test packages which may be tarred or zipped and moved cross platform.

+

The target being fully specified in the name means the file doesn't have to be read for the target to be determined

+

Extensions to behaviour should be added in the file as text data in Toml format,

+

with custom data being under a single application-chosen table name

+

The toplevel Toml table [fauxlink] is reserved for core extensions to this system.

+

Aside from the 2 used for delimiting (+ #)

+

certain characters which might normally be allowed in filesystems are required to be encoded

+

e.g space and tab are required to be %20 %09

+

Others that require encoding are: * ? \ / | : ; " < >

+

The nul character in raw form, when detected, is always mapped away to the empty string - as very few filesystems support it.

+

Control characters and other punctuation is optional to encode.

+

Generally utf-8 should be used where possible and unicode characters can often be left unencoded on modern systems.

+

Where encoding of unicode is desired in the nominalname,encodedtarget,tag or comment portions it can be specified as %UXXXXXXXX

+

There must be between 1 and 8 X digits following the %U. Interpretation of chars following %U stops at the first non-hex character.

+

This means %Utest would not get any translation as there were no hex digits so it would come out as %Utest + ++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++

+
+

Overview

+

overview of fauxlink

+ +

dependencies

+

packages used by fauxlink

+
    +

  • Tcl 8.6-

    • +
+
+
+

API

+

Namespace fauxlink::class

+

class definitions

+
    +
+
+

Namespace fauxlink

+

Core API functions for fauxlink

+
+
+
+

Namespace fauxlink::lib

+

Secondary functions that are part of the API

+
+
+
+
+

Internal

+

Namespace fauxlink::system

+

Internal functions that are not part of the API

+
+
+ + +
diff --git a/src/embedded/www/doc/files/_module_modpod-0.1.0.tm.html b/src/embedded/www/doc/files/_module_modpod-0.1.2.tm.html similarity index 94% rename from src/embedded/www/doc/files/_module_modpod-0.1.0.tm.html rename to src/embedded/www/doc/files/_module_modpod-0.1.2.tm.html index 3ec6b86a..3c9647b1 100644 --- a/src/embedded/www/doc/files/_module_modpod-0.1.0.tm.html +++ b/src/embedded/www/doc/files/_module_modpod-0.1.2.tm.html @@ -91,7 +91,7 @@ } --> - @@ -103,7 +103,7 @@ | Keyword Index ]
-

modpod_module_modpod(0) 0.1.0 doc "-"

+

modpod_module_modpod(0) 0.1.2 doc "-"

Name

modpod_module_modpod - Module API

diff --git a/src/embedded/www/doc/files/_module_overtype-1.6.5.tm.html b/src/embedded/www/doc/files/_module_overtype-1.6.5.tm.html index d4ef4a72..c8f39747 100644 --- a/src/embedded/www/doc/files/_module_overtype-1.6.5.tm.html +++ b/src/embedded/www/doc/files/_module_overtype-1.6.5.tm.html @@ -163,7 +163,7 @@

Core API functions for overtype

overtype::renderspace args
-

usage: ?-transparent [0|1]? ?-overflow [1|0]? ?-ellipsis [1|0]? ?-ellipsistext ...? undertext overtext

+

usage: ?-transparent [0|1]? ?-expand_right [1|0]? ?-ellipsis [1|0]? ?-ellipsistext ...? undertext overtext

overtype::renderline args

renderline is the core engine for overtype string processing (frames & textblocks), and the raw mode commandline repl for the Tcl Punk Shell

It is also a central part of an ansi (micro) virtual terminal-emulator of sorts

diff --git a/src/embedded/www/doc/files/_module_poshinfo-0.1.0.tm.html b/src/embedded/www/doc/files/_module_poshinfo-0.1.0.tm.html index c11bb199..d3184219 100644 --- a/src/embedded/www/doc/files/_module_poshinfo-0.1.0.tm.html +++ b/src/embedded/www/doc/files/_module_poshinfo-0.1.0.tm.html @@ -1,5 +1,5 @@ -shellspy_module_poshinfo - - +punkshell_module_poshinfo - POSH-related prompt tool + + + + +
[ + Main Table Of Contents +| Table Of Contents +| Keyword Index + ]
+
+

punkshell_module_textblock(0) 0.1.2 doc "punk textblock"

+

Name

+

punkshell_module_textblock - punk textblock functions

+
+ + +

Description

+

Ansi-aware terminal textblock manipulation

+
+

Overview

+

overview of textblock

+ +

dependencies

+

packages used by textblock

+
    +

  • Tcl 8.6-

    • +

  • punk::args

    • +

  • punk::char

    • +

  • punk::ansi

    • +

  • punk::lib

    • +

  • overtype

    • +

  • term::ansi::code::macros

    • +

  • textutil

    • +
+
+
+

API

+

Namespace textblock::class

+

class definitions

+ +

Already uniform blocks will join faster than textblock::join, and ragged blocks will join in a ragged manner +" + Already uniform blocks will join faster than textblock::join, and ragged blocks will join in a ragged manner +"

+
+
+ + +
diff --git a/src/embedded/www/doc/files/_module_tomlish-1.1.1.tm.html b/src/embedded/www/doc/files/_module_tomlish-1.1.1.tm.html index 0e477ec3..b4031a30 100644 --- a/src/embedded/www/doc/files/_module_tomlish-1.1.1.tm.html +++ b/src/embedded/www/doc/files/_module_tomlish-1.1.1.tm.html @@ -1,5 +1,5 @@ -tomlish_module_tomlish - - +tomlish_module_tomlish - tomlish + + + + +
[ + Main Table Of Contents +| Table Of Contents +| Keyword Index + ]
+
+

punkshell_module_punk::blockletter(0) 0.1.0 doc "-"

+

Name

+

punkshell_module_punk::blockletter - punk::blockletter frame-based large lettering test/logo

+
+ +

Synopsis

+
+
    +
  • package require punk::blockletter
    • +
+
+
+

Description

+

This is primarily designed to test large lettering using the block2 frametype which requires the right font support

+

More reasonably sized block-lettering could be obtained using unicode half-blocks instead - but that doesn't allow the frame outline effect that block2 gives.

+

Individual blocks have a minimum width of 4 columns and a minimum height of 2 rows (smallest element that can be fully framed)

+
+

Overview

+

overview of punk::blockletter

+ +

dependencies

+

packages used by punk::blockletter

+
    +

  • Tcl 8.6

    • +

  • textblock

    • +
+
+
+

API

+

Namespace punk::blockletter::class

+

class definitions +if { eq ""} {

+
    +
+

} +} + ++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++

+
+

Namespace punk::blockletter

+

Core API functions for punk::blockletter

+
+
+
+

Namespace punk::blockletter::lib

+

Secondary functions that are part of the API

+
+
+
+
+

Internal

+

tcl::namespace::eval punk::blockletter::system {

+

Namespace punk::blockletter::system

+

Internal functions that are not part of the API

+
+
+ + +
diff --git a/src/embedded/www/doc/files/punk/_module_cesu-0.1.0.tm.html b/src/embedded/www/doc/files/punk/_module_cesu-0.1.0.tm.html new file mode 100644 index 00000000..36b325cd --- /dev/null +++ b/src/embedded/www/doc/files/punk/_module_cesu-0.1.0.tm.html @@ -0,0 +1,184 @@ + +punkshell_module_punk::cesu - CESU experimental + + + + + +
[ + Main Table Of Contents +| Table Of Contents +| Keyword Index + ]
+
+

punkshell_module_punk::cesu(0) 0.1.0 doc "CESU experimental"

+

Name

+

punkshell_module_punk::cesu - CESU compatibility ehcoding scheme for utf-16: 8-Bit (CESU-8) ??

+
+ +

Synopsis

+
+
    +
  • package require punk::cesu
    • +
+
+
+

Description

+

experimental

+
+

Overview

+

overview of punk::cesu

+

Concepts

+

cesu-8 may be mistaken for utf-8 if no supplementary chars present.

+

see: https://www.unicode.org/reports/tr26/tr26-4.html

+

Particulary note discouragement of use especially in external interchange.

+
+

dependencies

+

packages used by punk::cesu

+
    +

  • Tcl 8.6

    • +
+
+
+

API

+

Namespace punk::cesu

+

Core API functions for punk::cesu

+
+
+
+

Namespace punk::cesu::lib

+

Secondary functions that are part of the API

+
+
+
+
+

Internal

+

tcl::namespace::eval punk::cesu::system {

+

Namespace punk::cesu::system

+

Internal functions that are not part of the API

+
+
+ + +
diff --git a/src/embedded/www/doc/files/punk/_module_experiment-0.1.0.tm.html b/src/embedded/www/doc/files/punk/_module_experiment-0.1.0.tm.html index aeda6b41..32aaf63a 100644 --- a/src/embedded/www/doc/files/punk/_module_experiment-0.1.0.tm.html +++ b/src/embedded/www/doc/files/punk/_module_experiment-0.1.0.tm.html @@ -1,5 +1,5 @@ -shellspy_module_punk::experiment - - +punkshell_module_punk::experiment - - + + + + +
[ + Main Table Of Contents +| Table Of Contents +| Keyword Index + ]
+
+

punkshell_module_punk::rest(0) 0.1.0 doc "experimental rest"

+

Name

+

punkshell_module_punk::rest - punk::rest

+
+ +

Synopsis

+
+
    +
  • package require punk::rest
    • +
+
+
+

Description

+

Experimental *basic rest as wrapper over http lib - use tcllib's rest package for a more complete implementation of a rest client

+
+

Overview

+

overview of punk::rest

+ +

dependencies

+

packages used by punk::rest

+
    +

  • Tcl 8.6

    • +
+
+
+

API

+

Namespace punk::rest::class

+

class definitions +if { eq ""} {

+
    +
+

} +} + ++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++

+
+

Namespace punk::rest

+

Core API functions for punk::rest

+
+
+
+

Namespace punk::rest::lib

+

Secondary functions that are part of the API

+
+
+
+
+

Internal

+

tcl::namespace::eval punk::rest::system {

+

Namespace punk::rest::system

+

Internal functions that are not part of the API

+
+
+ + +
diff --git a/src/embedded/www/doc/files/punk/_module_sshrun-0.1.0.tm.html b/src/embedded/www/doc/files/punk/_module_sshrun-0.1.0.tm.html index c7f50e74..0beda852 100644 --- a/src/embedded/www/doc/files/punk/_module_sshrun-0.1.0.tm.html +++ b/src/embedded/www/doc/files/punk/_module_sshrun-0.1.0.tm.html @@ -1,5 +1,5 @@ -shellspy_module_punk::sshrun - punk::sshrun tclssh clone +punkshell_module_punk::sshrun - punk::sshrun tclssh clone + + + + +
[ + Main Table Of Contents +| Table Of Contents +| Keyword Index + ]
+
+

punkshell_module_punk::trie(0) 0.1.0 doc "punk::trie"

+

Name

+

punkshell_module_punk::trie - punk::trie API

+
+ +

Synopsis

+
+
    +
  • package require punk::trie
    • +
+ +
+
+

Description

+

tcl trie implementation courtesy of CmcC (tcl wiki)

+

-

+
+

Overview

+

overview of punk::trie

+ +

dependencies

+

packages used by punk::trie

+
    +

  • Tcl 8.6

    • +
+
+
+

API

+

Namespace punk::trie

+

Core API functions for punk::trie

+
    +

  1. CLASS trieclass

    +
    +
    class::trieclass matches t what
    +

    search for longest prefix, return matching prefix, element and suffix

    +
    +
    2. +
+
+

Namespace punk::trie::lib

+

Secondary functions that are part of the API

+
+
+
+
+

Internal

+

tcl::namespace::eval punk::trie::system {

+

Namespace punk::trie::system

+

Internal functions that are not part of the API

+
+
+ + +
diff --git a/src/embedded/www/doc/files/punk/_module_uc-0.1.0.tm.html b/src/embedded/www/doc/files/punk/_module_uc-0.1.0.tm.html index b02285af..baab8dd8 100644 --- a/src/embedded/www/doc/files/punk/_module_uc-0.1.0.tm.html +++ b/src/embedded/www/doc/files/punk/_module_uc-0.1.0.tm.html @@ -1,5 +1,5 @@ -shellspy_module_punk::uc - - +punkshell_module_punk::uc - - - -
[ - Main Table Of Contents -| Table Of Contents -| Keyword Index + Main Table Of Contents +| Table Of Contents +| Keyword Index ]
-

overtype_module_overtype(0) 1.6.4 doc "overtype text layout"

+

punkshell_module_punk::winlnk(0) 0.1.0 doc "punk::winlnk"

Name

-

overtype_module_overtype - overtype text layout - ansi aware

+

punkshell_module_punk::winlnk - windows shortcut .lnk library

Table Of Contents

    @@ -120,7 +120,14 @@
  • API +
    • +
  • Internal +
  • Keywords
    • @@ -130,60 +137,66 @@

    Description

    -

    -

    +

    Tools for reading windows shortcuts (.lnk files) on any platform

    Overview

    -

    overview of overtype

    +

    overview of punk::winlnk

    Concepts

    -

    -

    +

    Windows shortcuts are a binary format file with a .lnk extension

    +

    Shell Link (.LNK) Binary File Format is documented in [MS_SHLLINK].pdf published by Microsoft.

    +

    Revision 8.0 published 2024-04-23

    dependencies

    -

    packages used by overtype

    +

    packages used by punk::winlnk

    • Tcl 8.6

      • -

    • textutil

      • -

    • punk::ansi

      -

      - required to detect, split, strip and calculate lengths of text possibly containing ansi codes

      • -

    • punk::char

      -

      - box drawing - and also unicode character width determination for proper layout of text with double-column-width chars

    API

    -

    Namespace overtype

    -

    Core API functions for overtype

    +

    Namespace punk::winlnk::class

    +

    class definitions +if { eq ""} {

    +
      +
    +

    } +} + ++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++

    +
    +

    Namespace punk::winlnk

    +

    Core API functions for punk::winlnk

    -
    overtype::renderspace args
    -

    usage: ?-transparent [0|1]? ?-overflow [1|0]? ?-ellipsis [1|0]? ?-ellipsistext ...? undertext overtext

    -
    overtype::renderline args
    -

    renderline is the core engine for overtype string processing (frames & textblocks), and the raw mode commandline repl for the Tcl Punk Shell

    -

    It is also a central part of an ansi (micro) virtual terminal-emulator of sorts

    -

    This system does a half decent job at rendering 90's ANSI art to manipulable colour text blocks that can be joined & framed for layout display within a unix or windows terminal

    -

    Renderline helps maintain ANSI text styling reset/replay codes so that the styling of one block doesn't affect another.

    -

    Calling on the punk::ansi library - it can coalesce codes to keep the size down.

    -

    It is a giant mess of doing exactly what common wisdom says not to do... lots at once.

    -

    renderline is part of the Unicode and ANSI aware Overtype system which 'renders' a block of text onto a static underlay

    -

    The underlay is generally expected to be an ordered set of lines or a rectangular text block analogous to a terminal screen - but it can also be ragged in line length, or just blank.

    -

    The overlay couuld be similar - in which case it may often be used to overwrite a column or section of the underlay.

    -

    The overlay could however be a sequence of ANSI-laden text that jumps all over the place.

    -

    renderline itself only deals with a single line - or sometimes a single character. It is generally called from a loop that does further terminal-like or textblock processing.

    -

    By suppyling the -info 1 option - it can return various fields indicating the state of the render.

    -

    The main 3 are the result, overflow_right, and unapplied.

    -

    Renderline handles cursor movements from either keystrokes or ANSI sequences but for a full system the aforementioned loop will need to be in place to manage the set of lines under manipulation.

    +
    file_check_header path
    +

    Return 0|1

    +

    Determines if the .lnk file specified in path has a valid header for a windows shortcut

    +
    file_get_info path
    +

    Return a dict of info obtained by parsing the binary data in a windows .lnk file

    +

    If the .lnk header check fails, then the .lnk file probably isn't really a shortcut file and the dictionary will contain an 'error' key

    +

    Namespace punk::winlnk::lib

    +

    Secondary functions that are part of the API

    +
    +
    +
    +
    +

    Internal

    +

    tcl::namespace::eval punk::winlnk::system {

    +

    Namespace punk::winlnk::system

    +

    Internal functions that are not part of the API

    +