Skip to content

Commit 24e1a16

Browse files
committed
1 parent b758642 commit 24e1a16

22 files changed

+64
-22
lines changed

public/docs/hyperpage/doxygen_crawl.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@
3939
<a href="index.html#autotoc_md3"/>
4040
<a href="index.html#autotoc_md4"/>
4141
<a href="index.html#autotoc_md5"/>
42+
<a href="index.html#autotoc_md6"/>
43+
<a href="index.html#autotoc_md7"/>
4244
<a href="namespacehyperpage.html"/>
4345
<a href="namespacehyperpage.html#aff9178552e147f16a5cb43a0b5d36878"/>
4446
<a href="namespacemembers.html"/>

public/docs/hyperpage/index.html

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,16 +119,33 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md3"></a>
119119
<h2 class="doxsection"><a class="anchor" id="autotoc_md4"></a>
120120
<span class="tt">hyperpack</span></h2>
121121
<p>Hyperpack is a command line utility used to create a hyperpage database file:</p>
122-
<div class="fragment"><div class="line">Usage: hyperpack [--help] [--output VAR] directory</div>
122+
<div class="fragment"><div class="line">Usage: hyperpack [--help] [--version] [--output VAR] [--verbose] directories...</div>
123123
<div class="line"> </div>
124124
<div class="line">Positional arguments:</div>
125-
<div class="line"> directory Directory to scan for files to pack into the hyperpage database [required]</div>
125+
<div class="line"> directories Directories to scan for files to pack into the hyperpage database [nargs: 1 or more] [required]</div>
126126
<div class="line"> </div>
127127
<div class="line">Optional arguments:</div>
128128
<div class="line"> -h, --help shows help message and exits</div>
129+
<div class="line"> -v, --version prints version information and exits</div>
129130
<div class="line"> -o, --output Output file for the hyperpage database [nargs=0..1] [default: &quot;hyperpage.db&quot;]</div>
130-
</div><!-- fragment --><p>It will iterate through a given directory, storing its files based on paths relative to the given directory. It will also detect the mime type and store the contents of each file.</p>
131-
<h2 class="doxsection"><a class="anchor" id="autotoc_md5"></a>
131+
<div class="line"> -v, --verbose Show detailed output information</div>
132+
</div><!-- fragment --><h2 class="doxsection"><a class="anchor" id="autotoc_md5"></a>
133+
Note on Overwriting</h2>
134+
<p>If two or more files share the same <b>relative subpath</b> (i.e., the same path within their respective parent directories), the file from the <b>rightmost directory</b> specified on the command line will overwrite the others in the final archive.</p>
135+
<p>Only <b>exact path matches</b> are considered conflicts — differing subdirectories or filenames will coexist as separate entries.</p>
136+
<h3 class="doxsection"><a class="anchor" id="autotoc_md6"></a>
137+
Example</h3>
138+
<p>Suppose you run: </p><div class="fragment"><div class="line">hyperpack -o output.hp dir1 dir2 dir3</div>
139+
</div><!-- fragment --><p> And the directories contain: </p><div class="fragment"><div class="line">dir1/Subdir1/index.html</div>
140+
<div class="line">dir2/Subdir2/index.html</div>
141+
<div class="line">dir3/Index.html</div>
142+
</div><!-- fragment --><p> These will result in three distinct files inside the archive: </p><div class="fragment"><div class="line">Subdir1/index.html</div>
143+
<div class="line">/Subdir2/index.html</div>
144+
<div class="line">/Index.html</div>
145+
</div><!-- fragment --><p> However, if two or more directories contain the same relative path, for example: </p><div class="fragment"><div class="line">dir1/public/index.html</div>
146+
<div class="line">dir2/public/index.html</div>
147+
</div><!-- fragment --><p> then the file from dir2 (the rightmost one) will overwrite the file from dir1 in the resulting archive entry: </p><div class="fragment"><div class="line">/public/index.html</div>
148+
</div><!-- fragment --> <h2 class="doxsection"><a class="anchor" id="autotoc_md7"></a>
132149
Documentation and Example</h2>
133150
<p>This is only intended to cover basic usage. For more info about the API, see the <a href="https://maxtek6.github.io/docs/hyperpage">docs</a>. To see how hyperpage is used in a basic use case, the <a href="https://github.com/maxtek6/hyperpage/tree/master/example">example</a> should be helpful. </p>
134151
</div></div><!-- PageDoc -->

public/docs/hyperpage/navtreedata.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,10 @@ var NAVTREE =
2929
[ "Usage", "index.html#autotoc_md2", [
3030
[ "<span class=\"tt\">hyperpage</span>", "index.html#autotoc_md3", null ],
3131
[ "<span class=\"tt\">hyperpack</span>", "index.html#autotoc_md4", null ],
32-
[ "Documentation and Example", "index.html#autotoc_md5", null ]
32+
[ "Note on Overwriting", "index.html#autotoc_md5", [
33+
[ "Example", "index.html#autotoc_md6", null ]
34+
] ],
35+
[ "Documentation and Example", "index.html#autotoc_md7", null ]
3336
] ],
3437
[ "Namespaces", "namespaces.html", [
3538
[ "Namespace List", "namespaces.html", "namespaces_dup" ],

public/docs/hyperpage/navtreeindex0.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ var NAVTREEINDEX0 =
3737
"index.html#autotoc_md3":[1,0],
3838
"index.html#autotoc_md4":[1,1],
3939
"index.html#autotoc_md5":[1,2],
40+
"index.html#autotoc_md6":[1,2,0],
41+
"index.html#autotoc_md7":[1,3],
4042
"namespacehyperpage.html":[2,0,0],
4143
"namespacehyperpage.html#aff9178552e147f16a5cb43a0b5d36878":[2,0,0,3],
4244
"namespacemembers.html":[2,1,0],
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
var searchData=
22
[
33
['abstract_0',['abstract',['../classabstract.html',1,'']]],
4-
['and_20example_1',['Documentation and Example',['../index.html#autotoc_md5',1,'']]]
4+
['and_20example_1',['Documentation and Example',['../index.html#autotoc_md7',1,'']]]
55
];
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
var searchData=
22
[
3-
['documentation_20and_20example_0',['Documentation and Example',['../index.html#autotoc_md5',1,'']]]
3+
['documentation_20and_20example_0',['Documentation and Example',['../index.html#autotoc_md7',1,'']]]
44
];
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
var searchData=
22
[
3-
['example_0',['Documentation and Example',['../index.html#autotoc_md5',1,'']]]
3+
['example_0',['Example',['../index.html#autotoc_md7',1,'Documentation and Example'],['../index.html#autotoc_md6',1,'Example']]]
44
];
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
var searchData=
22
[
3-
['page_0',['page',['../classhyperpage_1_1page.html',1,'hyperpage']]]
3+
['note_20on_20overwriting_0',['Note on Overwriting',['../index.html#autotoc_md5',1,'']]]
44
];
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
var searchData=
22
[
3-
['reader_0',['reader',['../classhyperpage_1_1reader.html',1,'hyperpage::reader'],['../classhyperpage_1_1reader.html#a4e4d4baffb2b674b59216f54cd6ad488',1,'hyperpage::reader::reader()']]],
4-
['readme_2emd_1',['README.md',['../README_8md.html',1,'']]],
5-
['requirements_2',['Requirements',['../index.html#autotoc_md1',1,'']]]
3+
['on_20overwriting_0',['Note on Overwriting',['../index.html#autotoc_md5',1,'']]],
4+
['overwriting_1',['Note on Overwriting',['../index.html#autotoc_md5',1,'']]]
65
];
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
var searchData=
22
[
3-
['store_0',['store',['../classhyperpage_1_1writer.html#a027c6b9de6186a02bd7c78f6ace82acf',1,'hyperpage::writer']]]
3+
['page_0',['page',['../classhyperpage_1_1page.html',1,'hyperpage']]]
44
];

0 commit comments

Comments
 (0)