<!DOCTYPE html><html><head>
<title>punkshell_module_punk::encmime - mime encoding names and aliases</title>
<style type="text/css"><!--
HTML {
background: #FFFFFF;
color: black;
}
BODY {
background: #FFFFFF;
color: black;
}
DIV.doctools {
margin-left: 10%;
margin-right: 10%;
}
DIV.doctools H1,DIV.doctools H2 {
margin-left: -5%;
}
H1, H2, H3, H4 {
margin-top: 1em;
font-family: sans-serif;
font-size: large;
color: #005A9C;
background: transparent;
text-align: left;
}
H1.doctools_title {
text-align: center;
}
UL,OL {
margin-right: 0em;
margin-top: 3pt;
margin-bottom: 3pt;
}
UL LI {
list-style: disc;
}
OL LI {
list-style: decimal;
}
DT {
padding-top: 1ex;
}
UL.doctools_toc,UL.doctools_toc UL, UL.doctools_toc UL UL {
font: normal 12pt/14pt sans-serif;
list-style: none;
}
LI.doctools_section, LI.doctools_subsection {
list-style: none;
margin-left: 0em;
text-indent: 0em;
padding: 0em;
}
PRE {
display: block;
font-family: monospace;
white-space: pre;
margin: 0%;
padding-top: 0.5ex;
padding-bottom: 0.5ex;
padding-left: 1ex;
padding-right: 1ex;
width: 100%;
}
PRE.doctools_example {
color: black;
background: #f5dcb3;
border: 1px solid black;
}
UL.doctools_requirements LI, UL.doctools_syntax LI {
list-style: none;
margin-left: 0em;
text-indent: 0em;
padding: 0em;
}
DIV.doctools_synopsis {
color: black;
background: #80ffff;
border: 1px solid black;
font-family: serif;
margin-top: 1em;
margin-bottom: 1em;
}
UL.doctools_syntax {
margin-top: 1em;
border-top: 1px solid black;
}
UL.doctools_requirements {
margin-bottom: 1em;
border-bottom: 1px solid black;
}
--></style>
</head>
<!-- Generated from file '_module_encmime-0.1.0.tm.man' by tcllib/doctools with format 'html'
-->
<!-- Copyright &copy; 2024
-->
<!-- punkshell_module_punk::encmime.0
-->
<body><hr> [
<a href="../../../toc.html">Main Table Of Contents</a>
| <a href="../../toc.html">Table Of Contents</a>
| <a href="../../../index.html">Keyword Index</a>
] <hr>
<div class="doctools">
<h1 class="doctools_title">punkshell_module_punk::encmime(0) 0.1.0 doc "mime encoding names and aliases"</h1>
<div id="name" class="doctools_section"><h2><a name="name">Name</a></h2>
<p>punkshell_module_punk::encmime - mime encodings related subset of tcllib mime</p>
</div>
<div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2>
<ul class="doctools_toc">
<li class="doctools_section"><a href="#toc">Table Of Contents</a></li>
<li class="doctools_section"><a href="#synopsis">Synopsis</a></li>
<li class="doctools_section"><a href="#section1">Description</a></li>
<li class="doctools_section"><a href="#section2">Overview</a>
<ul>
<li class="doctools_subsection"><a href="#subsection1">Concepts</a></li>
<li class="doctools_subsection"><a href="#subsection2">dependencies</a></li>
</ul>
</li>
<li class="doctools_section"><a href="#section3">API</a>
<ul>
<li class="doctools_subsection"><a href="#subsection3">Namespace punk::encmime::class</a></li>
<li class="doctools_subsection"><a href="#subsection4">Namespace punk::encmime</a></li>
<li class="doctools_subsection"><a href="#subsection5">Namespace punk::encmime::lib</a></li>
</ul>
</li>
<li class="doctools_section"><a href="#section4">Internal</a>
<ul>
<li class="doctools_subsection"><a href="#subsection6">Namespace punk::encmime::system</a></li>
</ul>
</li>
<li class="doctools_section"><a href="#keywords">Keywords</a></li>
<li class="doctools_section"><a href="#copyright">Copyright</a></li>
</ul>
</div>
<div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2>
<div class="doctools_synopsis">
<ul class="doctools_requirements">
<li>package require <b class="pkgname">punk::encmime</b></li>
</ul>
<ul class="doctools_syntax">
<li><a href="#1">mapencoding <i class="arg">enc</i></a></li>
<li><a href="#2">reversemapencoding <i class="arg">mimeType</i></a></li>
</ul>
</div>
</div>
<div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2>
<p>This is a workaround package to provide the mime encoding names used in tcllib's mime package - without additional dependencies</p>
<p>tcllib mime loads either Trf or tcl::memchan functions. punk::encmime needs to work in a context where tcllib may not yet be loaded/available, and even these few dependencies are too much.</p>
<p>MAINTENANCE NOTE: The data in this module needs to be checked against the latest tcllib mime package</p>
<p>taken from tcllib mime version: 1.7.2 in 2024</p>
</div>
<div id="section2" class="doctools_section"><h2><a name="section2">Overview</a></h2>
<p>overview of punk::encmime</p>
<div id="subsection1" class="doctools_subsection"><h3><a name="subsection1">Concepts</a></h3>
<p>Where practical - the actual tcllib mime package should be used instead.</p>
<p>This set of encoding related functions is a snapshot of the data from the mime package - and may not be up to date.</p>
<p>This pseudo-package was created to minimize dependencies for punk::char and punk::overtype</p>
</div>
<div id="subsection2" class="doctools_subsection"><h3><a name="subsection2">dependencies</a></h3>
<p>packages used by punk::encmime</p>
<ul class="doctools_itemized">
<li><p><b class="package">Tcl 8.6-</b></p></li>
</ul>
</div>
</div>
<div id="section3" class="doctools_section"><h2><a name="section3">API</a></h2>
<div id="subsection3" class="doctools_subsection"><h3><a name="subsection3">Namespace punk::encmime::class</a></h3>
<p>class definitions</p>
<ol class="doctools_enumerated">
</ol>
</div>
<div id="subsection4" class="doctools_subsection"><h3><a name="subsection4">Namespace punk::encmime</a></h3>
<p>Core API functions for punk::encmime</p>
<dl class="doctools_definitions">
<dt><a name="1">mapencoding <i class="arg">enc</i></a></dt>
<dd><p>maps tcl encodings onto the proper names for their MIME charset type.</p>
<p>This is only done for encodings whose charset types were known.</p>
<p>The remaining encodings return {} for now.</p>
<p>NOTE: consider using tcllib's mime::mapencoding instead if mime package available</p></dd>
<dt><a name="2">reversemapencoding <i class="arg">mimeType</i></a></dt>
<dd><p>mime::reversemapencodings maps MIME charset types onto tcl encoding names.</p>
<p>Returns the tcl encoding name for the specified mime charset, or {} if none is known</p>
<p>Arguments:</p>
<dl class="doctools_arguments">
<dt>string <i class="arg">mimeType</i></dt>
<dd><p>The MIME charset to convert into a tcl encoding type.</p></dd>
</dl>
<p>NOTE: consider using tcllib's mime::reversemapencoding instead if mime package available</p></dd>
</dl>
</div>
<div id="subsection5" class="doctools_subsection"><h3><a name="subsection5">Namespace punk::encmime::lib</a></h3>
<p>Secondary functions that are part of the API</p>
<dl class="doctools_definitions">
</dl>
</div>
</div>
<div id="section4" class="doctools_section"><h2><a name="section4">Internal</a></h2>
<div id="subsection6" class="doctools_subsection"><h3><a name="subsection6">Namespace punk::encmime::system</a></h3>
<p>Internal functions that are not part of the API</p>
</div>
</div>
<div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2>
<p><a href="../../../index.html#encodings">encodings</a>, <a href="../../../index.html#module">module</a></p>
</div>
<div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2>
<p>Copyright © 2024</p>
</div>
</div></body></html>