Skip to content

Commit

Permalink
Add minor fixes to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chpock committed Jun 19, 2024
1 parent 57102b2 commit 1ea0cb8
Show file tree
Hide file tree
Showing 10 changed files with 58 additions and 57 deletions.
1 change: 1 addition & 0 deletions ChangeLog
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
2024-06-19 Konstantin Kushnir <[email protected]>
* Add support for specifying the compression level
* Add minor fixes to documentation according to recent changes

2024-06-18 Konstantin Kushnir <[email protected]>
* Add multi-threading support
Expand Down
24 changes: 12 additions & 12 deletions doc/cookfs.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html><html><head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>cookfs - vfs::cookfs</title>
<title>cookfs - cookfs</title>
<style type="text/css"><!--
HTML {
background: #FFFFFF;
Expand Down Expand Up @@ -100,9 +100,9 @@
<!-- cookfs.n
-->
<body><div class="doctools">
<h1 class="doctools_title">cookfs(n) 1.7.0 cookfs &quot;vfs::cookfs&quot;</h1>
<h1 class="doctools_title">cookfs(n) 1.7.0 cookfs &quot;cookfs&quot;</h1>
<div id="name" class="doctools_section"><h2><a name="name">Name</a></h2>
<p>cookfs - vfs::cookfs</p>
<p>cookfs - cookfs</p>
</div>
<div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2>
<ul class="doctools_toc">
Expand All @@ -126,7 +126,7 @@ <h1 class="doctools_title">cookfs(n) 1.7.0 cookfs &quot;vfs::cookfs&quot;</h1>
<div class="doctools_synopsis">
<ul class="doctools_requirements">
<li>package require <b class="pkgname">Tcl 8.5</b></li>
<li>package require <b class="pkgname">vfs::cookfs <span class="opt">?1.7.0?</span></b></li>
<li>package require <b class="pkgname">cookfs <span class="opt">?1.7.0?</span></b></li>
</ul>
<ul class="doctools_syntax">
<li><a href="#1"><b class="cmd">::cookfs::Mount</b> <span class="opt">?<i class="arg">options</i>?</span> <i class="arg">archive</i> <i class="arg">local</i> <span class="opt">?<i class="arg">options</i>?</span></a></li>
Expand All @@ -146,7 +146,7 @@ <h1 class="doctools_title">cookfs(n) 1.7.0 cookfs &quot;vfs::cookfs&quot;</h1>
</div>
</div>
<div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2>
<p>Package <b class="package">vfs::cookfs</b> is a Tcl virtual filesystem (VFS) that allows
<p>Package <b class="package">cookfs</b> is a Tcl virtual filesystem (VFS) that allows
storing one or more files in a single file. This is similar to mk4vfs, zipvfs
and many other archive formats.</p>
<p>The main difference is that cookfs was designed for Tcl-related use and is
Expand Down Expand Up @@ -270,7 +270,7 @@ <h1 class="doctools_title">cookfs(n) 1.7.0 cookfs &quot;vfs::cookfs&quot;</h1>
<p>See <span class="sectref"><a href="#section4">COOKFS STORAGE</a></span> for more details on how cookfs stores files, index and metadata.</p></dd>
<dt><b class="option">-volume</b></dt>
<dd><p>Register mount point as Tcl volume - useful for creating mount points in locations that do not exist - such as <i class="arg">archive://</i>.</p></dd>
<dt><b class="option">-compression</b> <i class="arg">none|zlib|bzip2|xz|custom</i><span class="opt">?:<i class="arg">level</i>?</span></dt>
<dt><b class="option">-compression</b> <i class="arg">none|zlib|bz2|lzma|custom</i><span class="opt">?:<i class="arg">level</i>?</span></dt>
<dd><p>Compression to use for storing new files.</p>
<p>See <span class="sectref"><a href="#section5">COMPRESSSION</a></span> for more details on compression in cookfs.</p></dd>
<dt><b class="option">-compresscommand</b> <i class="arg">tcl command</i></dt>
Expand Down Expand Up @@ -353,11 +353,11 @@ <h1 class="doctools_title">cookfs(n) 1.7.0 cookfs &quot;vfs::cookfs&quot;</h1>
<p>For example:</p>
<pre class="doctools_example">
# This will mount an archive with the zlib compression method and with default level (9)
vfs::cookfs::Mount archive archive -compression zlib
cookfs::Mount archive archive -compression zlib
# This will mount an archive with the lzma compression method and with compression level 3
vfs::cookfs::Mount archive archive -compression lzma:3
cookfs::Mount archive archive -compression lzma:3
# This will mount an archive with the bzip2 compression method and with the maximum compression level for that method (9)
vfs::cookfs::Mount archive archive -compression bz2:255
cookfs::Mount archive archive -compression bz2:255
</pre>
<p>Cookfs provides the following compressions:</p>
<ul class="doctools_itemized">
Expand All @@ -370,8 +370,8 @@ <h1 class="doctools_title">cookfs(n) 1.7.0 cookfs &quot;vfs::cookfs&quot;</h1>
<li><p><b class="const">bz2</b> -
use bzip2 for compression; requires specifying <b class="const">--enable-bz2</b> when building
cookfs. Compression levels can be from 1 to 9.</p></li>
<li><p><b class="const">xz</b> -
use xz for compression; requires specifying <b class="const">--enable-xz</b> when building
<li><p><b class="const">lzma</b> -
use lzma for compression; requires specifying <b class="const">--enable-lzma</b> when building
cookfs. Compression levels can be from 0 to 9.</p></li>
<li><p><b class="const">custom</b> -
use Tcl commands for compressing and decompressing pages. The compression level
Expand All @@ -391,7 +391,7 @@ <h1 class="doctools_title">cookfs(n) 1.7.0 cookfs &quot;vfs::cookfs&quot;</h1>
set rc [vfs::zip -mode decompress [binary format H* [string range $d 8 end]]]
return $rc
}
vfs::cookfs::Mount archive archive -compression custom -compresscommand testc -decompresscommand testd
cookfs::Mount archive archive -compression custom -compresscommand testc -decompresscommand testd
</pre>
<p>See <span class="sectref"><a href="#section4">COOKFS STORAGE</a></span> for more details on how files are stored in cookfs.</p>
<p>Default values for <i class="arg">-pagesize</i>, <i class="arg">-smallfilesize</i> and
Expand Down
22 changes: 11 additions & 11 deletions doc/cookfs.man
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[manpage_begin cookfs n 1.7.0]
[copyright {2010-2011 Wojciech Kocjan <[email protected]>}]
[copyright {2024 Konstantin Kushnir <[email protected]>}]
[moddesc {vfs::cookfs}]
[titledesc {vfs::cookfs}]
[moddesc {cookfs}]
[titledesc {cookfs}]
[require Tcl 8.5]
[require vfs::cookfs [opt 1.7.0]]
[require cookfs [opt 1.7.0]]

[description]

Package [package vfs::cookfs] is a Tcl virtual filesystem (VFS) that allows
Package [package cookfs] is a Tcl virtual filesystem (VFS) that allows
storing one or more files in a single file. This is similar to mk4vfs, zipvfs
and many other archive formats.

Expand Down Expand Up @@ -203,7 +203,7 @@ See [sectref {COOKFS STORAGE}] for more details on how cookfs stores files, inde
[def "[option -volume]"]
Register mount point as Tcl volume - useful for creating mount points in locations that do not exist - such as [arg archive://].

[def "[option -compression] [arg {none|zlib|bzip2|xz|custom}][opt :[arg level]]"]
[def "[option -compression] [arg {none|zlib|bz2|lzma|custom}][opt :[arg level]]"]

Compression to use for storing new files.

Expand Down Expand Up @@ -332,13 +332,13 @@ the maximum compression level will be used for the chosen compression method.
For example:
[example {
# This will mount an archive with the zlib compression method and with default level (9)
vfs::cookfs::Mount archive archive -compression zlib
cookfs::Mount archive archive -compression zlib

# This will mount an archive with the lzma compression method and with compression level 3
vfs::cookfs::Mount archive archive -compression lzma:3
cookfs::Mount archive archive -compression lzma:3

# This will mount an archive with the bzip2 compression method and with the maximum compression level for that method (9)
vfs::cookfs::Mount archive archive -compression bz2:255
cookfs::Mount archive archive -compression bz2:255
}]

[para]
Expand All @@ -358,8 +358,8 @@ can be from 0 to 9.
use bzip2 for compression; requires specifying [const {--enable-bz2}] when building
cookfs. Compression levels can be from 1 to 9.

[item] [const xz] -
use xz for compression; requires specifying [const {--enable-xz}] when building
[item] [const lzma] -
use lzma for compression; requires specifying [const {--enable-lzma}] when building
cookfs. Compression levels can be from 0 to 9.

[item] [const custom] -
Expand All @@ -385,7 +385,7 @@ proc testd {d} {
return $rc
}

vfs::cookfs::Mount archive archive -compression custom -compresscommand testc -decompresscommand testd
cookfs::Mount archive archive -compression custom -compresscommand testc -decompresscommand testd
}]

[para]
Expand Down
22 changes: 11 additions & 11 deletions doc/cookfs.n
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
'\" Copyright (c) 2010-2011 Wojciech Kocjan <wojciech@kocjan\&.org>
'\" Copyright (c) 2024 Konstantin Kushnir <chpock@gmail\&.com>
'\"
.TH "cookfs" n 1\&.7\&.0 cookfs "vfs::cookfs"
.TH "cookfs" n 1\&.7\&.0 cookfs "cookfs"
.\" The -*- nroff -*- definitions below are for supplemental macros used
.\" in Tcl/Tk manual entries.
.\"
Expand Down Expand Up @@ -273,11 +273,11 @@ Database Class: \\fB\\$3\\fR
..
.BS
.SH NAME
cookfs \- vfs::cookfs
cookfs \- cookfs
.SH SYNOPSIS
package require \fBTcl 8\&.5\fR
.sp
package require \fBvfs::cookfs ?1\&.7\&.0?\fR
package require \fBcookfs ?1\&.7\&.0?\fR
.sp
\fB::cookfs::Mount\fR ?\fIoptions\fR? \fIarchive\fR \fIlocal\fR ?\fIoptions\fR?
.sp
Expand Down Expand Up @@ -307,7 +307,7 @@ package require \fBvfs::cookfs ?1\&.7\&.0?\fR
.sp
.BE
.SH DESCRIPTION
Package \fBvfs::cookfs\fR is a Tcl virtual filesystem (VFS) that allows
Package \fBcookfs\fR is a Tcl virtual filesystem (VFS) that allows
storing one or more files in a single file\&. This is similar to mk4vfs, zipvfs
and many other archive formats\&.
.PP
Expand Down Expand Up @@ -474,7 +474,7 @@ See \fBCOOKFS STORAGE\fR for more details on how cookfs stores files, index and
\fB-volume\fR
Register mount point as Tcl volume - useful for creating mount points in locations that do not exist - such as \fIarchive://\fR\&.
.TP
\fB-compression\fR \fInone|zlib|bzip2|xz|custom\fR?:\fIlevel\fR?
\fB-compression\fR \fInone|zlib|bz2|lzma|custom\fR?:\fIlevel\fR?
Compression to use for storing new files\&.
.sp
See \fBCOMPRESSSION\fR for more details on compression in cookfs\&.
Expand Down Expand Up @@ -582,13 +582,13 @@ For example:


# This will mount an archive with the zlib compression method and with default level (9)
vfs::cookfs::Mount archive archive -compression zlib
cookfs::Mount archive archive -compression zlib

# This will mount an archive with the lzma compression method and with compression level 3
vfs::cookfs::Mount archive archive -compression lzma:3
cookfs::Mount archive archive -compression lzma:3

# This will mount an archive with the bzip2 compression method and with the maximum compression level for that method (9)
vfs::cookfs::Mount archive archive -compression bz2:255
cookfs::Mount archive archive -compression bz2:255

.CE
.PP
Expand All @@ -606,8 +606,8 @@ can be from 0 to 9\&.
use bzip2 for compression; requires specifying \fB--enable-bz2\fR when building
cookfs\&. Compression levels can be from 1 to 9\&.
.IP \(bu
\fBxz\fR -
use xz for compression; requires specifying \fB--enable-xz\fR when building
\fBlzma\fR -
use lzma for compression; requires specifying \fB--enable-lzma\fR when building
cookfs\&. Compression levels can be from 0 to 9\&.
.IP \(bu
\fBcustom\fR -
Expand All @@ -632,7 +632,7 @@ proc testd {d} {
return $rc
}

vfs::cookfs::Mount archive archive -compression custom -compresscommand testc -decompresscommand testd
cookfs::Mount archive archive -compression custom -compresscommand testc -decompresscommand testd

.CE
.PP
Expand Down
8 changes: 4 additions & 4 deletions doc/cookfs_fsindex.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html><html><head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>cookfs::fsindex - vfs::cookfs::fsindex</title>
<title>cookfs::fsindex - cookfs::fsindex</title>
<style type="text/css"><!--
HTML {
background: #FFFFFF;
Expand Down Expand Up @@ -100,9 +100,9 @@
<!-- cookfs::fsindex.n
-->
<body><div class="doctools">
<h1 class="doctools_title">cookfs::fsindex(n) 1.7.0 cookfs_fsindex &quot;vfs::cookfs::fsindex&quot;</h1>
<h1 class="doctools_title">cookfs::fsindex(n) 1.7.0 cookfs_fsindex &quot;cookfs::fsindex&quot;</h1>
<div id="name" class="doctools_section"><h2><a name="name">Name</a></h2>
<p>cookfs::fsindex - vfs::cookfs::fsindex</p>
<p>cookfs::fsindex - cookfs::fsindex</p>
</div>
<div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2>
<ul class="doctools_toc">
Expand All @@ -120,7 +120,7 @@ <h1 class="doctools_title">cookfs::fsindex(n) 1.7.0 cookfs_fsindex &quot;vfs::co
<div class="doctools_synopsis">
<ul class="doctools_requirements">
<li>package require <b class="pkgname">Tcl 8.5</b></li>
<li>package require <b class="pkgname">vfs::cookfs <span class="opt">?1.7.0?</span></b></li>
<li>package require <b class="pkgname">cookfs <span class="opt">?1.7.0?</span></b></li>
</ul>
<ul class="doctools_syntax">
<li><a href="#1"><b class="cmd">::cookfs::fsindex</b> <span class="opt">?<i class="arg">exportedData</i>?</span></a></li>
Expand Down
6 changes: 3 additions & 3 deletions doc/cookfs_fsindex.man
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[manpage_begin cookfs::fsindex n 1.7.0]
[copyright {2010-2011 Wojciech Kocjan <[email protected]>}]
[copyright {2024 Konstantin Kushnir <[email protected]>}]
[moddesc {vfs::cookfs::fsindex}]
[titledesc {vfs::cookfs::fsindex}]
[moddesc {cookfs::fsindex}]
[titledesc {cookfs::fsindex}]
[require Tcl 8.5]
[require vfs::cookfs [opt 1.7.0]]
[require cookfs [opt 1.7.0]]

[description]

Expand Down
6 changes: 3 additions & 3 deletions doc/cookfs_fsindex.n
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
'\" Copyright (c) 2010-2011 Wojciech Kocjan <wojciech@kocjan\&.org>
'\" Copyright (c) 2024 Konstantin Kushnir <chpock@gmail\&.com>
'\"
.TH "cookfs::fsindex" n 1\&.7\&.0 cookfs_fsindex "vfs::cookfs::fsindex"
.TH "cookfs::fsindex" n 1\&.7\&.0 cookfs_fsindex "cookfs::fsindex"
.\" The -*- nroff -*- definitions below are for supplemental macros used
.\" in Tcl/Tk manual entries.
.\"
Expand Down Expand Up @@ -273,11 +273,11 @@ Database Class: \\fB\\$3\\fR
..
.BS
.SH NAME
cookfs::fsindex \- vfs::cookfs::fsindex
cookfs::fsindex \- cookfs::fsindex
.SH SYNOPSIS
package require \fBTcl 8\&.5\fR
.sp
package require \fBvfs::cookfs ?1\&.7\&.0?\fR
package require \fBcookfs ?1\&.7\&.0?\fR
.sp
\fB::cookfs::fsindex\fR ?\fIexportedData\fR?
.sp
Expand Down
10 changes: 5 additions & 5 deletions doc/cookfs_pages.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html><html><head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>cookfs::pages - vfs::cookfs::pages</title>
<title>cookfs::pages - cookfs::pages</title>
<style type="text/css"><!--
HTML {
background: #FFFFFF;
Expand Down Expand Up @@ -100,9 +100,9 @@
<!-- cookfs::pages.n
-->
<body><div class="doctools">
<h1 class="doctools_title">cookfs::pages(n) 1.7.0 cookfs_pages &quot;vfs::cookfs::pages&quot;</h1>
<h1 class="doctools_title">cookfs::pages(n) 1.7.0 cookfs_pages &quot;cookfs::pages&quot;</h1>
<div id="name" class="doctools_section"><h2><a name="name">Name</a></h2>
<p>cookfs::pages - vfs::cookfs::pages</p>
<p>cookfs::pages - cookfs::pages</p>
</div>
<div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2>
<ul class="doctools_toc">
Expand All @@ -120,7 +120,7 @@ <h1 class="doctools_title">cookfs::pages(n) 1.7.0 cookfs_pages &quot;vfs::cookfs
<div class="doctools_synopsis">
<ul class="doctools_requirements">
<li>package require <b class="pkgname">Tcl 8.5</b></li>
<li>package require <b class="pkgname">vfs::cookfs <span class="opt">?1.7.0?</span></b></li>
<li>package require <b class="pkgname">cookfs <span class="opt">?1.7.0?</span></b></li>
</ul>
<ul class="doctools_syntax">
<li><a href="#1"><b class="cmd">::cookfs::pages</b> <span class="opt">?<i class="arg">options</i>?</span> <i class="arg">archive</i></a></li>
Expand Down Expand Up @@ -233,7 +233,7 @@ <h1 class="doctools_title">cookfs::pages(n) 1.7.0 cookfs_pages &quot;vfs::cookfs
<dd><p>Read archive starting at specified offset, instead of reading from end of file.</p>
<p>This feature is used when cookfs archive is not stored at end of file - for example if it is
used in tclkit and followed by mk4vfs archive.</p></dd>
<dt><b class="option">-compression</b> <i class="arg">none|zlib|bzip2|xz|custom</i></dt>
<dt><b class="option">-compression</b> <i class="arg">none|zlib|bz2|lzma|custom</i></dt>
<dd><p>Compression to use for storing new files.</p>
<p>See <b class="sectref">cookfs</b> for more details on compression in cookfs.</p></dd>
<dt><b class="option">-compresscommand</b> <i class="arg">tcl command</i></dt>
Expand Down
8 changes: 4 additions & 4 deletions doc/cookfs_pages.man
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[manpage_begin cookfs::pages n 1.7.0]
[copyright {2010-2011 Wojciech Kocjan <[email protected]>}]
[copyright {2024 Konstantin Kushnir <[email protected]>}]
[moddesc {vfs::cookfs::pages}]
[titledesc {vfs::cookfs::pages}]
[moddesc {cookfs::pages}]
[titledesc {cookfs::pages}]
[require Tcl 8.5]
[require vfs::cookfs [opt 1.7.0]]
[require cookfs [opt 1.7.0]]

[description]

Expand Down Expand Up @@ -146,7 +146,7 @@ Read archive starting at specified offset, instead of reading from end of file.
This feature is used when cookfs archive is not stored at end of file - for example if it is
used in tclkit and followed by mk4vfs archive.

[def "[option -compression] [arg {none|zlib|bzip2|xz|custom}]"]
[def "[option -compression] [arg {none|zlib|bz2|lzma|custom}]"]
Compression to use for storing new files.

[para]
Expand Down
8 changes: 4 additions & 4 deletions doc/cookfs_pages.n
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
'\" Copyright (c) 2010-2011 Wojciech Kocjan <wojciech@kocjan\&.org>
'\" Copyright (c) 2024 Konstantin Kushnir <chpock@gmail\&.com>
'\"
.TH "cookfs::pages" n 1\&.7\&.0 cookfs_pages "vfs::cookfs::pages"
.TH "cookfs::pages" n 1\&.7\&.0 cookfs_pages "cookfs::pages"
.\" The -*- nroff -*- definitions below are for supplemental macros used
.\" in Tcl/Tk manual entries.
.\"
Expand Down Expand Up @@ -273,11 +273,11 @@ Database Class: \\fB\\$3\\fR
..
.BS
.SH NAME
cookfs::pages \- vfs::cookfs::pages
cookfs::pages \- cookfs::pages
.SH SYNOPSIS
package require \fBTcl 8\&.5\fR
.sp
package require \fBvfs::cookfs ?1\&.7\&.0?\fR
package require \fBcookfs ?1\&.7\&.0?\fR
.sp
\fB::cookfs::pages\fR ?\fIoptions\fR? \fIarchive\fR
.sp
Expand Down Expand Up @@ -435,7 +435,7 @@ Read archive starting at specified offset, instead of reading from end of file\&
This feature is used when cookfs archive is not stored at end of file - for example if it is
used in tclkit and followed by mk4vfs archive\&.
.TP
\fB-compression\fR \fInone|zlib|bzip2|xz|custom\fR
\fB-compression\fR \fInone|zlib|bz2|lzma|custom\fR
Compression to use for storing new files\&.
.sp
See \fBcookfs\fR for more details on compression in cookfs\&.
Expand Down

0 comments on commit 1ea0cb8

Please sign in to comment.