From 971cb33aca1940cc4a7500ccc41a8f22ddb3a8ff Mon Sep 17 00:00:00 2001 From: Julian Noble Date: Fri, 4 Aug 2023 23:59:53 +1000 Subject: [PATCH] Initial doc framework --- src/build.tcl | 5 +- src/doc/include/general.inc | 6 + src/doc/include/welcome.inc | 6 + src/doc/include/welcome_basic.inc | 5 + src/doc/main.man | 13 ++ src/embedded/man/files/main.n | 291 +++++++++++++++++++++++++++ src/embedded/man/index.n | 281 ++++++++++++++++++++++++++ src/embedded/man/toc.n | 277 +++++++++++++++++++++++++ src/embedded/md/.doc/tocdoc | 3 + src/embedded/md/.idx | 1 + src/embedded/md/.toc | 1 + src/embedded/md/.xrf | 1 + src/embedded/md/doc/files/main.md | 45 +++++ src/embedded/md/doc/toc.md | 6 + src/embedded/md/index.md | 16 ++ src/embedded/md/toc.md | 6 + src/embedded/www/.doc/tocdoc | 3 + src/embedded/www/.idx | 1 + src/embedded/www/.toc | 1 + src/embedded/www/.xrf | 1 + src/embedded/www/doc/files/main.html | 136 +++++++++++++ src/embedded/www/doc/toc.html | 20 ++ src/embedded/www/index.html | 28 +++ src/embedded/www/toc.html | 20 ++ 24 files changed, 1172 insertions(+), 1 deletion(-) create mode 100644 src/doc/include/general.inc create mode 100644 src/doc/include/welcome.inc create mode 100644 src/doc/include/welcome_basic.inc create mode 100644 src/doc/main.man create mode 100644 src/embedded/man/files/main.n create mode 100644 src/embedded/man/index.n create mode 100644 src/embedded/man/toc.n create mode 100644 src/embedded/md/.doc/tocdoc create mode 100644 src/embedded/md/.idx create mode 100644 src/embedded/md/.toc create mode 100644 src/embedded/md/.xrf create mode 100644 src/embedded/md/doc/files/main.md create mode 100644 src/embedded/md/doc/toc.md create mode 100644 src/embedded/md/index.md create mode 100644 src/embedded/md/toc.md create mode 100644 src/embedded/www/.doc/tocdoc create mode 100644 src/embedded/www/.idx create mode 100644 src/embedded/www/.toc create mode 100644 src/embedded/www/.xrf create mode 100644 src/embedded/www/doc/files/main.html create mode 100644 src/embedded/www/doc/toc.html create mode 100644 src/embedded/www/index.html create mode 100644 src/embedded/www/toc.html diff --git a/src/build.tcl b/src/build.tcl index 8b137891..07d32686 100644 --- a/src/build.tcl +++ b/src/build.tcl @@ -1 +1,4 @@ - +#!/bin/sh +# -*- tcl -*- \ +exec ./kettle -f "$0" "${1+$@}" +kettle doc diff --git a/src/doc/include/general.inc b/src/doc/include/general.inc new file mode 100644 index 00000000..04950d5f --- /dev/null +++ b/src/doc/include/general.inc @@ -0,0 +1,6 @@ +[comment {-*- tcl -*- --- !doctools --- manpage}] +[comment {- -- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---}] +[moddesc {punkshell - a Tcl }] +[category {shell}] +[keywords {shell repl}] +[require Tcl 8.6] diff --git a/src/doc/include/welcome.inc b/src/doc/include/welcome.inc new file mode 100644 index 00000000..9b47e8ec --- /dev/null +++ b/src/doc/include/welcome.inc @@ -0,0 +1,6 @@ +[comment {-*- tcl -*- --- !doctools --- manpage}] +[comment {- -- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---}] +[include welcome_basic.inc] + +[para] Please read the document [term {punkshell - Introduction to punkshell}], +if you have not done so already, to get an overview of the whole system. diff --git a/src/doc/include/welcome_basic.inc b/src/doc/include/welcome_basic.inc new file mode 100644 index 00000000..f7c86b32 --- /dev/null +++ b/src/doc/include/welcome_basic.inc @@ -0,0 +1,5 @@ +[comment {-*- tcl -*- --- !doctools --- manpage}] +[comment {- - -- --- ----- -------- ------------- ---------------------}] +[para] + +Welcome to the punkshell project. diff --git a/src/doc/main.man b/src/doc/main.man new file mode 100644 index 00000000..682f50de --- /dev/null +++ b/src/doc/main.man @@ -0,0 +1,13 @@ +[comment {-*- tcl -*- --- doctools ---}] +[manpage_begin punkshell n 1] +[include include/general.inc] +[titledesc {punkshell - Core}] +[description] +[para] +[include include/welcome.inc] +[para] + +This document is the reference to commands and modules provided by punkshell + + +[manpage_end] \ No newline at end of file diff --git a/src/embedded/man/files/main.n b/src/embedded/man/files/main.n new file mode 100644 index 00000000..79d1771a --- /dev/null +++ b/src/embedded/man/files/main.n @@ -0,0 +1,291 @@ +'\" +'\" Generated from file 'main\&.man' by tcllib/doctools with format 'nroff' +'\" +.TH "punkshell" n 1 doc "punkshell - a Tcl" +.\" 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 \- punkshell - Core +.SH SYNOPSIS +package require \fBTcl 8\&.6\fR +.sp +.BE +.SH DESCRIPTION +.PP +.PP +Welcome to the punkshell project\&. +.PP +Please read the document \fIpunkshell - Introduction to punkshell\fR, +if you have not done so already, to get an overview of the whole system\&. +.PP +This document is the reference to commands and modules provided by punkshell +.SH KEYWORDS +shell repl +.SH CATEGORY +shell diff --git a/src/embedded/man/index.n b/src/embedded/man/index.n new file mode 100644 index 00000000..16492545 --- /dev/null +++ b/src/embedded/man/index.n @@ -0,0 +1,281 @@ +'\" +'\" Generated by tcllib/doctools/idx with format 'nroff' +.TH "Keyword Index" n +.\" 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 INDEX +doc +.RS +shell repl +.RS +.TP +\fBfiles/main\&.n\fR +punkshell +.RE +.RE diff --git a/src/embedded/man/toc.n b/src/embedded/man/toc.n new file mode 100644 index 00000000..41aa4869 --- /dev/null +++ b/src/embedded/man/toc.n @@ -0,0 +1,277 @@ +'\" +'\" Generated by tcllib/doctools/toc with format 'nroff' +.TH "Table Of Contents" n +.\" 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 CONTENTS +doc +.RS +.TP +\fBpunkshell\fR +\fIfiles/main\&.n\fR: punkshell - Core diff --git a/src/embedded/md/.doc/tocdoc b/src/embedded/md/.doc/tocdoc new file mode 100644 index 00000000..b810fbd9 --- /dev/null +++ b/src/embedded/md/.doc/tocdoc @@ -0,0 +1,3 @@ +[toc_begin {Table Of Contents} doc] +[item doc/files/main.md punkshell {punkshell - Core}] +[toc_end] diff --git a/src/embedded/md/.idx b/src/embedded/md/.idx new file mode 100644 index 00000000..eaf8b456 --- /dev/null +++ b/src/embedded/md/.idx @@ -0,0 +1 @@ +{{shell repl} {{doc/files/main.md punkshell}}} {{{shell repl} doc/files/main.md punkshell} .} 1 {{shell repl} shell_repl} \ No newline at end of file diff --git a/src/embedded/md/.toc b/src/embedded/md/.toc new file mode 100644 index 00000000..99dfdfcf --- /dev/null +++ b/src/embedded/md/.toc @@ -0,0 +1 @@ +doc {doc/toc {{doc/files/main.md punkshell {punkshell - Core}}}} \ No newline at end of file diff --git a/src/embedded/md/.xrf b/src/embedded/md/.xrf new file mode 100644 index 00000000..bfda8175 --- /dev/null +++ b/src/embedded/md/.xrf @@ -0,0 +1 @@ +{punkshell - Core} doc/files/main.md sa,punkshell(n) doc/files/main.md punkshell(n) doc/files/main.md {kw,shell repl} {index.md shell_repl} sa,punkshell doc/files/main.md punkshell doc/files/main.md {shell repl} {index.md shell_repl} \ No newline at end of file diff --git a/src/embedded/md/doc/files/main.md b/src/embedded/md/doc/files/main.md new file mode 100644 index 00000000..5bea7212 --- /dev/null +++ b/src/embedded/md/doc/files/main.md @@ -0,0 +1,45 @@ + +[//000000001]: # (punkshell \- punkshell \- a Tcl ) +[//000000002]: # (Generated from file 'main\.man' by tcllib/doctools with format 'markdown') +[//000000003]: # (punkshell\(n\) 1 doc "punkshell \- a Tcl ") + +
[ Main Table Of Contents | Table Of Contents | Keyword Index ]
+ +# NAME + +punkshell \- punkshell \- Core + +# Table Of Contents + + - [Table Of Contents](#toc) + + - [Synopsis](#synopsis) + + - [Description](#section1) + + - [Keywords](#keywords) + + - [Category](#category) + +# SYNOPSIS + +package require Tcl 8\.6 + +# DESCRIPTION + +Welcome to the punkshell project\. + +Please read the document *punkshell \- Introduction to punkshell*, if you have +not done so already, to get an overview of the whole system\. + +This document is the reference to commands and modules provided by punkshell + +# KEYWORDS + +[shell repl](\.\./\.\./index\.md\#shell\_repl) + +# CATEGORY + +shell diff --git a/src/embedded/md/doc/toc.md b/src/embedded/md/doc/toc.md new file mode 100644 index 00000000..e60533d6 --- /dev/null +++ b/src/embedded/md/doc/toc.md @@ -0,0 +1,6 @@ + +[//000000001]: # (Table of contents generated by tcllib/doctools/toc with format 'markdown') + +# Table Of Contents \-\- doc + + - [punkshell](doc/files/main\.md) punkshell \- Core diff --git a/src/embedded/md/index.md b/src/embedded/md/index.md new file mode 100644 index 00000000..d50c03bb --- /dev/null +++ b/src/embedded/md/index.md @@ -0,0 +1,16 @@ + +[//000000001]: # (Index generated by tcllib/doctools/idx with format 'markdown') + +# Keyword Index + +---- + +[S](#cS) + +---- + +#### Keywords: S + +||| +|---|---| +|shell repl|[punkshell](doc/files/main\.md)| diff --git a/src/embedded/md/toc.md b/src/embedded/md/toc.md new file mode 100644 index 00000000..e60533d6 --- /dev/null +++ b/src/embedded/md/toc.md @@ -0,0 +1,6 @@ + +[//000000001]: # (Table of contents generated by tcllib/doctools/toc with format 'markdown') + +# Table Of Contents \-\- doc + + - [punkshell](doc/files/main\.md) punkshell \- Core diff --git a/src/embedded/www/.doc/tocdoc b/src/embedded/www/.doc/tocdoc new file mode 100644 index 00000000..8e5bce6c --- /dev/null +++ b/src/embedded/www/.doc/tocdoc @@ -0,0 +1,3 @@ +[toc_begin {Table Of Contents} doc] +[item doc/files/main.html punkshell {punkshell - Core}] +[toc_end] diff --git a/src/embedded/www/.idx b/src/embedded/www/.idx new file mode 100644 index 00000000..cabab38f --- /dev/null +++ b/src/embedded/www/.idx @@ -0,0 +1 @@ +{{shell repl} {{doc/files/main.html punkshell}}} {{{shell repl} doc/files/main.html punkshell} .} 1 {{shell repl} shell_repl} \ No newline at end of file diff --git a/src/embedded/www/.toc b/src/embedded/www/.toc new file mode 100644 index 00000000..46581f3a --- /dev/null +++ b/src/embedded/www/.toc @@ -0,0 +1 @@ +doc {doc/toc {{doc/files/main.html punkshell {punkshell - Core}}}} \ No newline at end of file diff --git a/src/embedded/www/.xrf b/src/embedded/www/.xrf new file mode 100644 index 00000000..9c7dd4fa --- /dev/null +++ b/src/embedded/www/.xrf @@ -0,0 +1 @@ +{punkshell - Core} doc/files/main.html sa,punkshell(n) doc/files/main.html punkshell(n) doc/files/main.html {kw,shell repl} {index.html shell_repl} sa,punkshell doc/files/main.html punkshell doc/files/main.html {shell repl} {index.html shell_repl} \ No newline at end of file diff --git a/src/embedded/www/doc/files/main.html b/src/embedded/www/doc/files/main.html new file mode 100644 index 00000000..bf9fe8e8 --- /dev/null +++ b/src/embedded/www/doc/files/main.html @@ -0,0 +1,136 @@ + +punkshell - punkshell - a Tcl + + + + +
[ + Main Table Of Contents +| Table Of Contents +| Keyword Index + ]
+
+

punkshell(n) 1 doc "punkshell - a Tcl "

+

Name

+

punkshell - punkshell - Core

+
+ +

Synopsis

+
+
    +
  • package require Tcl 8.6
    • +
+
+
+

Description

+

Welcome to the punkshell project.

+

Please read the document punkshell - Introduction to punkshell, +if you have not done so already, to get an overview of the whole system.

+

This document is the reference to commands and modules provided by punkshell

+
+ +

Category

+

shell

+
+
\ No newline at end of file diff --git a/src/embedded/www/doc/toc.html b/src/embedded/www/doc/toc.html new file mode 100644 index 00000000..010ab281 --- /dev/null +++ b/src/embedded/www/doc/toc.html @@ -0,0 +1,20 @@ + + Table Of Contents + + + + +
[ + Keyword Index + ]
+

Table Of Contents

+

doc

+ + + + + +
punkshellpunkshell - Core
+
diff --git a/src/embedded/www/index.html b/src/embedded/www/index.html new file mode 100644 index 00000000..b00d0be0 --- /dev/null +++ b/src/embedded/www/index.html @@ -0,0 +1,28 @@ + + + + + + Keyword Index + + +
[ + Table Of Contents + ]
+

Keyword Index

+
+ S +
+
+ + + + +
+Keywords: S +
shell repl + punkshell +
+ \ No newline at end of file diff --git a/src/embedded/www/toc.html b/src/embedded/www/toc.html new file mode 100644 index 00000000..2af2910d --- /dev/null +++ b/src/embedded/www/toc.html @@ -0,0 +1,20 @@ + + Table Of Contents + + + + +
[ + Keyword Index + ]
+

Table Of Contents

+

doc

+ + + + + +
punkshellpunkshell - Core
+