187 changed files with 2200 additions and 1726 deletions
@ -0,0 +1,33 @@
|
||||
[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 dollarcent_module_dollarcent 0 1.1] |
||||
[copyright "2025"] |
||||
[titledesc {Module API}] [comment {-- Name section and table of contents description --}] |
||||
[moddesc {-}] [comment {-- Description at end of page heading --}] |
||||
[require dollarcent] |
||||
[keywords module] |
||||
[description] |
||||
[para] - |
||||
[section Overview] |
||||
[para] overview of dollarcent |
||||
[subsection Concepts] |
||||
[para] - |
||||
[subsection dependencies] |
||||
[para] packages used by dollarcent |
||||
[list_begin itemized] |
||||
[item] [package {Tcl 8.6-}] |
||||
[list_end] |
||||
[section API] |
||||
[subsection {Namespace dollarcent}] |
||||
[para] Core API functions for dollarcent |
||||
[list_begin definitions] |
||||
[list_end] [comment {--- end definitions namespace dollarcent ---}] |
||||
[subsection {Namespace dollarcent::lib}] |
||||
[para] Secondary functions that are part of the API |
||||
[list_begin definitions] |
||||
[list_end] [comment {--- end definitions namespace dollarcent::lib ---}] |
||||
[section Internal] |
||||
[subsection {Namespace dollarcent::system}] |
||||
[para] Internal functions that are not part of the API |
||||
[manpage_end] |
||||
@ -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.5] |
||||
[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]? ?-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 |
||||
[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] |
||||
@ -0,0 +1,30 @@
|
||||
[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::pdf 0 0.1.0] |
||||
[copyright "2025"] |
||||
[titledesc {Module API}] [comment {-- Name section and table of contents description --}] |
||||
[moddesc {-}] [comment {-- Description at end of page heading --}] |
||||
[require punk::pdf] |
||||
[keywords module] |
||||
[description] |
||||
[para] - |
||||
[section Overview] |
||||
[para] overview of punk::pdf |
||||
[subsection Concepts] |
||||
[para] - |
||||
[subsection dependencies] |
||||
[para] packages used by punk::pdf |
||||
[list_begin itemized] |
||||
[item] [package {Tcl 8.6}] |
||||
[list_end] |
||||
[section API] |
||||
[subsection {Namespace punk::pdf}] |
||||
[para] Core API functions for punk::pdf |
||||
[list_begin definitions] |
||||
[list_end] [comment {--- end definitions namespace punk::pdf ---}] |
||||
[subsection {Namespace punk::pdf::lib}] |
||||
[para] Secondary functions that are part of the API |
||||
[list_begin definitions] |
||||
[list_end] [comment {--- end definitions namespace punk::pdf::lib ---}] |
||||
[manpage_end] |
||||
@ -1,37 +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 punkshell_module_punk::args::tclcore 0 0.1.0] |
||||
[copyright "2025"] |
||||
[titledesc {punk::args definitions for tcl core commands}] [comment {-- Name section and table of contents description --}] |
||||
[moddesc {tcl core argument definitions}] [comment {-- Description at end of page heading --}] |
||||
[require punk::args::tclcore] |
||||
[keywords module] |
||||
[description] |
||||
[para] - |
||||
[section Overview] |
||||
[para] overview of punk::args::tclcore |
||||
[subsection Concepts] |
||||
[para] - |
||||
[subsection dependencies] |
||||
[para] packages used by punk::args::tclcore |
||||
[list_begin itemized] |
||||
[item] [package {Tcl 8.6}] |
||||
[item] [package {punk::args}] |
||||
[item] [package {textblock}] |
||||
[list_end] |
||||
[section API] |
||||
[subsection {Namespace punk::args::tclcore}] |
||||
[para] Core API functions for punk::args::tclcore |
||||
[list_begin definitions] |
||||
[list_end] [comment {--- end definitions namespace punk::args::tclcore ---}] |
||||
[subsection {Namespace punk::args::tclcore::lib}] |
||||
[para] Secondary functions that are part of the API |
||||
[list_begin definitions] |
||||
[list_end] [comment {--- end definitions namespace punk::args::tclcore::lib ---}] |
||||
[section Internal] |
||||
tcl::namespace::eval punk::args::tclcore::system { |
||||
*** !doctools |
||||
[subsection {Namespace punk::args::tclcore::system}] |
||||
[para] Internal functions that are not part of the API |
||||
[manpage_end] |
||||
@ -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::args::moduledoc::tclcore 0 0.1.0] |
||||
[copyright "2025"] |
||||
[titledesc {punk::args definitions for tcl core commands}] [comment {-- Name section and table of contents description --}] |
||||
[moddesc {tcl core argument definitions}] [comment {-- Description at end of page heading --}] |
||||
[require punk::args::moduledoc::tclcore] |
||||
[keywords module] |
||||
[description] |
||||
[para] - |
||||
[section Overview] |
||||
[para] overview of punk::args::moduledoc::tclcore |
||||
[subsection Concepts] |
||||
[para] This is a punk::args module documentation package. |
||||
[para] It provides punk::args definitions for core Tcl commands, |
||||
[subsection dependencies] |
||||
[para] packages used by punk::args::moduledoc::tclcore |
||||
[list_begin itemized] |
||||
[item] [package {Tcl 8.6}] |
||||
[item] [package {punk::args}] |
||||
[item] [package {punk::ansi}] |
||||
[item] [package {textblock}] |
||||
[list_end] |
||||
[section API] |
||||
[subsection {Namespace punk::args::moduledoc::tclcore::argdoc}] |
||||
[para] This is the main documentation namespace where calls to punk::args::define are made, and definitions are added to the punk::args::moduledoc::tclcore::argdoc::PUNKARGS variable. |
||||
[para] Some utility functions exist here for use in the definitions. |
||||
[list_begin definitions] |
||||
[list_end] [comment {--- end definitions namespace punk::args::moduledoc::tclcore::argdoc ---}] |
||||
[subsection {Namespace punk::args::moduledoc::tclcore}] |
||||
[para] Core API functions for punk::args::moduledoc::tclcore |
||||
[list_begin definitions] |
||||
[list_end] [comment {--- end definitions namespace punk::args::moduledoc::tclcore ---}] |
||||
[subsection {Namespace punk::args::moduledoc::tclcore::lib}] |
||||
[para] Secondary functions that are part of the API |
||||
[list_begin definitions] |
||||
[list_end] [comment {--- end definitions namespace punk::args::moduledoc::tclcore::lib ---}] |
||||
[manpage_end] |
||||
@ -1,37 +1,32 @@
|
||||
[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::args::tkcore 0 0.1.0] |
||||
[manpage_begin punkshell_module_punk::args::moduledoc::tkcore 0 0.1.1] |
||||
[copyright "2025"] |
||||
[titledesc {Module API}] [comment {-- Name section and table of contents description --}] |
||||
[moddesc {-}] [comment {-- Description at end of page heading --}] |
||||
[require punk::args::tkcore] |
||||
[require punk::args::moduledoc::tkcore] |
||||
[keywords module] |
||||
[description] |
||||
[para] - |
||||
[section Overview] |
||||
[para] overview of punk::args::tkcore |
||||
[para] overview of punk::args::moduledoc::tkcore |
||||
[subsection Concepts] |
||||
[para] - |
||||
[subsection dependencies] |
||||
[para] packages used by punk::args::tkcore |
||||
[para] packages used by punk::args::moduledoc::tkcore |
||||
[list_begin itemized] |
||||
[item] [package {Tcl 8.6}] |
||||
[item] [package {punk::args}] |
||||
[item] [package {textblock}] |
||||
[list_end] |
||||
[section API] |
||||
[subsection {Namespace punk::args::tkcore}] |
||||
[para] Core API functions for punk::args::tkcore |
||||
[subsection {Namespace punk::args::moduledoc::tkcore}] |
||||
[para] Core API functions for punk::args::moduledoc::tkcore |
||||
[list_begin definitions] |
||||
[list_end] [comment {--- end definitions namespace punk::args::tkcore ---}] |
||||
[subsection {Namespace punk::args::tkcore::lib}] |
||||
[list_end] [comment {--- end definitions namespace punk::args::moduledoc::tkcore ---}] |
||||
[subsection {Namespace punk::args::moduledoc::tkcore::lib}] |
||||
[para] Secondary functions that are part of the API |
||||
[list_begin definitions] |
||||
[list_end] [comment {--- end definitions namespace punk::args::tkcore::lib ---}] |
||||
[section Internal] |
||||
tcl::namespace::eval punk::args::tkcore::system { |
||||
*** !doctools |
||||
[subsection {Namespace punk::args::tkcore::system}] |
||||
[para] Internal functions that are not part of the API |
||||
[list_end] [comment {--- end definitions namespace punk::args::moduledoc::tkcore::lib ---}] |
||||
[manpage_end] |
||||
@ -1,26 +1,26 @@
|
||||
[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::args::tzint 0 1.1.1] |
||||
[manpage_begin punkshell_module_punk::args::moduledoc::tzint 0 1.1.1] |
||||
[copyright "2025"] |
||||
[titledesc {Module API}] [comment {-- Name section and table of contents description --}] |
||||
[moddesc {-}] [comment {-- Description at end of page heading --}] |
||||
[require punk::args::tzint] |
||||
[require punk::args::moduledoc::tzint] |
||||
[keywords module] |
||||
[description] |
||||
[para] - |
||||
[section Overview] |
||||
[para] overview of punk::args::tzint |
||||
[para] overview of punk::args::moduledoc::tzint |
||||
[subsection Concepts] |
||||
[para] - |
||||
[subsection dependencies] |
||||
[para] packages used by punk::args::tzint |
||||
[para] packages used by punk::args::moduledoc::tzint |
||||
[list_begin itemized] |
||||
[item] [package {Tcl 8.6}] |
||||
[list_end] |
||||
[section API] |
||||
[subsection {Namespace punk::args::tzint}] |
||||
[para] Core API functions for punk::args::tzint |
||||
[subsection {Namespace punk::args::moduledoc::tzint}] |
||||
[para] Core API functions for punk::args::moduledoc::tzint |
||||
[list_begin definitions] |
||||
[list_end] [comment {--- end definitions namespace punk::args::tzint ---}] |
||||
[list_end] [comment {--- end definitions namespace punk::args::moduledoc::tzint ---}] |
||||
[manpage_end] |
||||
@ -1,5 +0,0 @@
|
||||
Documents and help files (for the repository website) |
||||
These are html, markdown, manfiles etc which live within src/embedded and are intended to be checked into source control so they can form part of the online documentation available when browsing the repository. |
||||
|
||||
These files shouldn't be modified directly as they are built from the files in the src/doc folder |
||||
(Using the Kettle build system) |
||||
@ -0,0 +1,328 @@
|
||||
'\" |
||||
'\" Generated from file '_module_ubl-0\&.1\&.0\&.tm\&.man' by tcllib/doctools with format 'nroff' |
||||
'\" Copyright (c) 2025 |
||||
'\" |
||||
.TH "punkshell_module_punk::ubl" 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::ubl \- Module API |
||||
.SH SYNOPSIS |
||||
package require \fBpunk::ubl\fR |
||||
.sp |
||||
.BE |
||||
.SH DESCRIPTION |
||||
.PP |
||||
Basic UBL |
||||
.PP |
||||
https://docs\&.oasis-open\&.org/ubl/os-UBL-2\&.4/ |
||||
++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ |
||||
.SH OVERVIEW |
||||
.PP |
||||
overview of punk::ubl |
||||
.SS CONCEPTS |
||||
.PP |
||||
- |
||||
.SS DEPENDENCIES |
||||
.PP |
||||
packages used by punk::ubl |
||||
.IP \(bu |
||||
\fBTcl 8\&.6\fR |
||||
.PP |
||||
.SH API |
||||
.SS "NAMESPACE PUNK::UBL::CLASS" |
||||
.PP |
||||
class definitions |
||||
if { eq ""} { |
||||
*** !doctools |
||||
.PP |
||||
} |
||||
} |
||||
++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ |
||||
.SS "NAMESPACE PUNK::UBL" |
||||
.PP |
||||
Core API functions for punk::ubl |
||||
.PP |
||||
.SS "NAMESPACE PUNK::UBL::LIB" |
||||
.PP |
||||
Secondary functions that are part of the API |
||||
.PP |
||||
.SH INTERNAL |
||||
tcl::namespace::eval punk::ubl::system { |
||||
*** !doctools |
||||
.SS "NAMESPACE PUNK::UBL::SYSTEM" |
||||
.PP |
||||
Internal functions that are not part of the API |
||||
.SH KEYWORDS |
||||
module |
||||
.SH COPYRIGHT |
||||
.nf |
||||
Copyright (c) 2025 |
||||
|
||||
.fi |
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -0,0 +1,84 @@
|
||||
|
||||
[//000000001]: # (dollarcent\_module\_dollarcent \- \-) |
||||
[//000000002]: # (Generated from file '\_module\_dollarcent\-1\.1\.tm\.man' by tcllib/doctools with format 'markdown') |
||||
[//000000003]: # (Copyright © 2025) |
||||
[//000000004]: # (dollarcent\_module\_dollarcent\(0\) 1\.1 doc "\-") |
||||
|
||||
<hr> [ <a href="../../../../../../home">Home</a> | <a |
||||
href="../../toc.md">Main Table Of Contents</a> | <a |
||||
href="../toc.md">Table Of Contents</a> | <a |
||||
href="../../index.md">Keyword Index</a> ] <hr> |
||||
|
||||
# NAME |
||||
|
||||
dollarcent\_module\_dollarcent \- Module API |
||||
|
||||
# <a name='toc'></a>Table Of Contents |
||||
|
||||
- [Table Of Contents](#toc) |
||||
|
||||
- [Synopsis](#synopsis) |
||||
|
||||
- [Description](#section1) |
||||
|
||||
- [Overview](#section2) |
||||
|
||||
- [Concepts](#subsection1) |
||||
|
||||
- [dependencies](#subsection2) |
||||
|
||||
- [API](#section3) |
||||
|
||||
- [Namespace dollarcent](#subsection3) |
||||
|
||||
- [Namespace dollarcent::lib](#subsection4) |
||||
|
||||
- [Internal](#section4) |
||||
|
||||
- [Namespace dollarcent::system](#subsection5) |
||||
|
||||
- [Keywords](#keywords) |
||||
|
||||
- [Copyright](#copyright) |
||||
|
||||
# <a name='synopsis'></a>SYNOPSIS |
||||
|
||||
package require dollarcent |
||||
|
||||
# <a name='description'></a>DESCRIPTION |
||||
|
||||
\- |
||||
|
||||
# <a name='section2'></a>Overview |
||||
|
||||
overview of dollarcent |
||||
|
||||
## <a name='subsection1'></a>Concepts |
||||
|
||||
\- |
||||
|
||||
## <a name='subsection2'></a>dependencies |
||||
|
||||
packages used by dollarcent |
||||
|
||||
- __Tcl 8\.6\-__ |
||||
|
||||
# <a name='section3'></a>API |
||||
|
||||
## <a name='subsection3'></a>Namespace dollarcent |
||||
|
||||
Core API functions for dollarcent |
||||
|
||||
## <a name='subsection4'></a>Namespace dollarcent::lib |
||||
|
||||
# <a name='section4'></a>Internal |
||||
|
||||
## <a name='subsection5'></a>Namespace dollarcent::system |
||||
|
||||
# <a name='keywords'></a>KEYWORDS |
||||
|
||||
[module](\.\./\.\./index\.md\#module) |
||||
|
||||
# <a name='copyright'></a>COPYRIGHT |
||||
|
||||
Copyright © 2025 |
||||
@ -1,139 +0,0 @@
|
||||
|
||||
[//000000001]: # (overtype\_module\_overtype \- overtype text layout) |
||||
[//000000002]: # (Generated from file '\_module\_overtype\-1\.6\.5\.tm\.man' by tcllib/doctools with format 'markdown') |
||||
[//000000003]: # (Copyright © 2024) |
||||
[//000000004]: # (overtype\_module\_overtype\(0\) 1\.6\.5 doc "overtype text layout") |
||||
|
||||
<hr> [ <a href="../../toc.md">Main Table Of Contents</a> | <a |
||||
href="../toc.md">Table Of Contents</a> | <a |
||||
href="../../index.md">Keyword Index</a> ] <hr> |
||||
|
||||
# NAME |
||||
|
||||
overtype\_module\_overtype \- overtype text layout \- ansi aware |
||||
|
||||
# <a name='toc'></a>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) |
||||
|
||||
# <a name='synopsis'></a>SYNOPSIS |
||||
|
||||
package require overtype |
||||
|
||||
[__overtype::renderspace__ *args*](#1) |
||||
[__overtype::renderline__ *args*](#2) |
||||
|
||||
# <a name='description'></a>DESCRIPTION |
||||
|
||||
\- |
||||
|
||||
# <a name='section2'></a>Overview |
||||
|
||||
overview of overtype |
||||
|
||||
## <a name='subsection1'></a>Concepts |
||||
|
||||
\- |
||||
|
||||
## <a name='subsection2'></a>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 |
||||
|
||||
# <a name='section3'></a>API |
||||
|
||||
## <a name='subsection3'></a>Namespace overtype |
||||
|
||||
Core API functions for overtype |
||||
|
||||
- <a name='1'></a>__overtype::renderspace__ *args* |
||||
|
||||
usage: ?\-transparent \[0|1\]? ?\-expand\_right \[1|0\]? ?\-ellipsis \[1|0\]? |
||||
?\-ellipsistext \.\.\.? undertext overtext |
||||
|
||||
- <a name='2'></a>__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\. |
||||
|
||||
# <a name='keywords'></a>KEYWORDS |
||||
|
||||
[ansi](\.\./\.\./index\.md\#ansi), [module](\.\./\.\./index\.md\#module), |
||||
[text](\.\./\.\./index\.md\#text) |
||||
|
||||
# <a name='copyright'></a>COPYRIGHT |
||||
|
||||
Copyright © 2024 |
||||
@ -1,87 +0,0 @@
|
||||
|
||||
[//000000001]: # (shellspy\_module\_pipe \- \-) |
||||
[//000000002]: # (Generated from file '\_module\_pipe\-1\.0\.tm\.man' by tcllib/doctools with format 'markdown') |
||||
[//000000003]: # (Copyright © 2025) |
||||
[//000000004]: # (shellspy\_module\_pipe\(0\) 1\.0 doc "\-") |
||||
|
||||
<hr> [ <a href="../../toc.md">Main Table Of Contents</a> | <a |
||||
href="../toc.md">Table Of Contents</a> | <a |
||||
href="../../index.md">Keyword Index</a> ] <hr> |
||||
|
||||
# NAME |
||||
|
||||
shellspy\_module\_pipe \- Module API |
||||
|
||||
# <a name='toc'></a>Table Of Contents |
||||
|
||||
- [Table Of Contents](#toc) |
||||
|
||||
- [Synopsis](#synopsis) |
||||
|
||||
- [Description](#section1) |
||||
|
||||
- [Overview](#section2) |
||||
|
||||
- [Concepts](#subsection1) |
||||
|
||||
- [dependencies](#subsection2) |
||||
|
||||
- [API](#section3) |
||||
|
||||
- [Namespace pipe::class](#subsection3) |
||||
|
||||
- [Namespace pipe](#subsection4) |
||||
|
||||
- [Namespace pipe::lib](#subsection5) |
||||
|
||||
- [Internal](#section4) |
||||
|
||||
- [Namespace pipe::system](#subsection6) |
||||
|
||||
- [Keywords](#keywords) |
||||
|
||||
- [Copyright](#copyright) |
||||
|
||||
# <a name='synopsis'></a>SYNOPSIS |
||||
|
||||
package require pipe |
||||
|
||||
# <a name='description'></a>DESCRIPTION |
||||
|
||||
\- |
||||
|
||||
# <a name='section2'></a>Overview |
||||
|
||||
overview of pipe |
||||
|
||||
## <a name='subsection1'></a>Concepts |
||||
|
||||
\- |
||||
|
||||
## <a name='subsection2'></a>dependencies |
||||
|
||||
packages used by pipe |
||||
|
||||
- __Tcl 8\.6__ |
||||
|
||||
# <a name='section3'></a>API |
||||
|
||||
## <a name='subsection3'></a>Namespace pipe::class |
||||
|
||||
class definitions if \{ eq ""\} \{ \*\*\* \!doctools |
||||
|
||||
## <a name='subsection4'></a>Namespace pipe |
||||
|
||||
## <a name='subsection5'></a>Namespace pipe::lib |
||||
|
||||
# <a name='section4'></a>Internal |
||||
|
||||
## <a name='subsection6'></a>Namespace pipe::system |
||||
|
||||
# <a name='keywords'></a>KEYWORDS |
||||
|
||||
[module](\.\./\.\./index\.md\#module) |
||||
|
||||
# <a name='copyright'></a>COPYRIGHT |
||||
|
||||
Copyright © 2025 |
||||
@ -0,0 +1,76 @@
|
||||
|
||||
[//000000001]: # (punkshell\_module\_punk::pdf \- \-) |
||||
[//000000002]: # (Generated from file '\_module\_pdf\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') |
||||
[//000000003]: # (Copyright © 2025) |
||||
[//000000004]: # (punkshell\_module\_punk::pdf\(0\) 0\.1\.0 doc "\-") |
||||
|
||||
<hr> [ <a href="../../../../../../../home">Home</a> | <a |
||||
href="../../../toc.md">Main Table Of Contents</a> | <a |
||||
href="../../toc.md">Table Of Contents</a> | <a |
||||
href="../../../index.md">Keyword Index</a> ] <hr> |
||||
|
||||
# NAME |
||||
|
||||
punkshell\_module\_punk::pdf \- Module API |
||||
|
||||
# <a name='toc'></a>Table Of Contents |
||||
|
||||
- [Table Of Contents](#toc) |
||||
|
||||
- [Synopsis](#synopsis) |
||||
|
||||
- [Description](#section1) |
||||
|
||||
- [Overview](#section2) |
||||
|
||||
- [Concepts](#subsection1) |
||||
|
||||
- [dependencies](#subsection2) |
||||
|
||||
- [API](#section3) |
||||
|
||||
- [Namespace punk::pdf](#subsection3) |
||||
|
||||
- [Namespace punk::pdf::lib](#subsection4) |
||||
|
||||
- [Keywords](#keywords) |
||||
|
||||
- [Copyright](#copyright) |
||||
|
||||
# <a name='synopsis'></a>SYNOPSIS |
||||
|
||||
package require punk::pdf |
||||
|
||||
# <a name='description'></a>DESCRIPTION |
||||
|
||||
\- |
||||
|
||||
# <a name='section2'></a>Overview |
||||
|
||||
overview of punk::pdf |
||||
|
||||
## <a name='subsection1'></a>Concepts |
||||
|
||||
\- |
||||
|
||||
## <a name='subsection2'></a>dependencies |
||||
|
||||
packages used by punk::pdf |
||||
|
||||
- __Tcl 8\.6__ |
||||
|
||||
# <a name='section3'></a>API |
||||
|
||||
## <a name='subsection3'></a>Namespace punk::pdf |
||||
|
||||
Core API functions for punk::pdf |
||||
|
||||
## <a name='subsection4'></a>Namespace punk::pdf::lib |
||||
|
||||
# <a name='keywords'></a>KEYWORDS |
||||
|
||||
[module](\.\./\.\./\.\./index\.md\#module) |
||||
|
||||
# <a name='copyright'></a>COPYRIGHT |
||||
|
||||
Copyright © 2025 |
||||
@ -0,0 +1,91 @@
|
||||
|
||||
[//000000001]: # (punkshell\_module\_punk::ubl \- \-) |
||||
[//000000002]: # (Generated from file '\_module\_ubl\-0\.1\.0\.tm\.man' by tcllib/doctools with format 'markdown') |
||||
[//000000003]: # (Copyright © 2025) |
||||
[//000000004]: # (punkshell\_module\_punk::ubl\(0\) 0\.1\.0 doc "\-") |
||||
|
||||
<hr> [ <a href="../../../../../../../home">Home</a> | <a |
||||
href="../../../toc.md">Main Table Of Contents</a> | <a |
||||
href="../../toc.md">Table Of Contents</a> | <a |
||||
href="../../../index.md">Keyword Index</a> ] <hr> |
||||
|
||||
# NAME |
||||
|
||||
punkshell\_module\_punk::ubl \- Module API |
||||
|
||||
# <a name='toc'></a>Table Of Contents |
||||
|
||||
- [Table Of Contents](#toc) |
||||
|
||||
- [Synopsis](#synopsis) |
||||
|
||||
- [Description](#section1) |
||||
|
||||
- [Overview](#section2) |
||||
|
||||
- [Concepts](#subsection1) |
||||
|
||||
- [dependencies](#subsection2) |
||||
|
||||
- [API](#section3) |
||||
|
||||
- [Namespace punk::ubl::class](#subsection3) |
||||
|
||||
- [Namespace punk::ubl](#subsection4) |
||||
|
||||
- [Namespace punk::ubl::lib](#subsection5) |
||||
|
||||
- [Internal](#section4) |
||||
|
||||
- [Namespace punk::ubl::system](#subsection6) |
||||
|
||||
- [Keywords](#keywords) |
||||
|
||||
- [Copyright](#copyright) |
||||
|
||||
# <a name='synopsis'></a>SYNOPSIS |
||||
|
||||
package require punk::ubl |
||||
|
||||
# <a name='description'></a>DESCRIPTION |
||||
|
||||
Basic UBL |
||||
|
||||
https://docs\.oasis\-open\.org/ubl/os\-UBL\-2\.4/ \+\+ \+\+\+ \+\+\+ \+\+\+ \+\+\+ \+\+\+ \+\+\+ \+\+\+ \+\+\+ |
||||
\+\+\+ \+\+\+ |
||||
|
||||
# <a name='section2'></a>Overview |
||||
|
||||
overview of punk::ubl |
||||
|
||||
## <a name='subsection1'></a>Concepts |
||||
|
||||
\- |
||||
|
||||
## <a name='subsection2'></a>dependencies |
||||
|
||||
packages used by punk::ubl |
||||
|
||||
- __Tcl 8\.6__ |
||||
|
||||
# <a name='section3'></a>API |
||||
|
||||
## <a name='subsection3'></a>Namespace punk::ubl::class |
||||
|
||||
class definitions if \{ eq ""\} \{ \*\*\* \!doctools |
||||
|
||||
## <a name='subsection4'></a>Namespace punk::ubl |
||||
|
||||
## <a name='subsection5'></a>Namespace punk::ubl::lib |
||||
|
||||
# <a name='section4'></a>Internal |
||||
|
||||
## <a name='subsection6'></a>Namespace punk::ubl::system |
||||
|
||||
# <a name='keywords'></a>KEYWORDS |
||||
|
||||
[module](\.\./\.\./\.\./index\.md\#module) |
||||
|
||||
# <a name='copyright'></a>COPYRIGHT |
||||
|
||||
Copyright © 2025 |
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue