deploy: 5111be0

book/cli/build.html

@@ -10,6 +10,6 @@
 <span class=nav-text>Command-line Utility</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=index.html>Introduction</a><li class=nav-item data-depth=1><a class=nav-link href=install.html>Installation</a><li class="nav-item is-current-page" data-depth=1><a class=nav-link href=build.html>How to Build</a><li class=nav-item data-depth=1><a class=nav-link href=usage.html>Usage</a><li class=nav-item data-depth=1><span class=nav-text>Manual pages</span><li class=nav-item data-depth=1><a class=nav-link href=man/man1/rscrypt.1.html><code>rscrypt(1)</code></a><li class=nav-item data-depth=1><a class=nav-link href=man/man1/rscrypt-enc.1.html><code>rscrypt-enc(1)</code></a><li class=nav-item data-depth=1><a class=nav-link href=man/man1/rscrypt-dec.1.html><code>rscrypt-dec(1)</code></a><li class=nav-item data-depth=1><a class=nav-link href=man/man1/rscrypt-info.1.html><code>rscrypt-info(1)</code></a><li class=nav-item data-depth=1><a class=nav-link href=man/man1/rscrypt-help.1.html><code>rscrypt-help(1)</code></a><li class=nav-item data-depth=1><a class=nav-link href=changelog.html>Changelog</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
 <span class=nav-text>Resources</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=../authors.html>List of Authors</a><li class=nav-item data-depth=1><a class=nav-link href=../license.html>License</a></ul></ul></nav></div><div class=nav-panel-explore data-panel=explore><div class=context><span class=title>scryptenc-rs</span>
 <span class=version></span></div><ul class=components><li class="component is-current"><div class=title><a href=../index.html>scryptenc-rs</a></div></ul></div></div></aside></div><main class=article><div class=toolbar role=navigation><button class=nav-toggle></button>
-<a href=../index.html class=home-link></a><nav class=breadcrumbs aria-label=breadcrumbs><ul><li><a href=../index.html>scryptenc-rs</a><li>Command-line Utility<li><a href=build.html>How to Build</a></ul></nav><div class=edit-this-page><a href=https://github.com/sorairolake/scryptenc-rs/edit/HEAD/docs/book/modules/cli/pages/build.adoc>Edit this Page</a></div></div><div class=content><aside class="toc sidebar" data-title=Contents data-levels=2><div class=toc-menu></div></aside><article class=doc><h1 class=page>How to Build</h1><div class=sect1><h2 id=_prerequisites><a class=anchor href=#_prerequisites></a>Prerequisites</h2><div class=sectionbody><div class=ulist><div class=title>To build <strong>rscrypt</strong>, you will need the following dependencies</div><ul><li><p><a href=https://doc.rust-lang.org/stable/cargo/>Cargo</a> (v1.70.0 or later)</ul></div><div class=ulist><div class=title>To build man pages, you will need the following additional dependencies</div><ul><li><p><a href=https://asciidoctor.org/>Asciidoctor</a></ul></div></div></div><div class=sect1><h2 id=_building_from_source><a class=anchor href=#_building_from_source></a>Building from source</h2><div class=sectionbody><div class=listingblock><div class=title>To clone the repository</div><div class=content><pre class="highlightjs highlight"><code class="language-sh hljs" data-lang=sh>git clone https://github.com/sorairolake/scryptenc-rs.git
+<a href=../index.html class=home-link></a><nav class=breadcrumbs aria-label=breadcrumbs><ul><li><a href=../index.html>scryptenc-rs</a><li>Command-line Utility<li><a href=build.html>How to Build</a></ul></nav><div class=edit-this-page><a href=https://github.com/sorairolake/scryptenc-rs/edit/HEAD/docs/book/modules/cli/pages/build.adoc>Edit this Page</a></div></div><div class=content><aside class="toc sidebar" data-title=Contents data-levels=2><div class=toc-menu></div></aside><article class=doc><h1 class=page>How to Build</h1><div class=sect1><h2 id=_prerequisites><a class=anchor href=#_prerequisites></a>Prerequisites</h2><div class=sectionbody><div class=ulist><div class=title>To build <strong>rscrypt</strong>, you will need the following dependencies</div><ul><li><p><a href=https://doc.rust-lang.org/stable/cargo/>Cargo</a> (v1.74.0 or later)</ul></div><div class=ulist><div class=title>To build man pages, you will need the following additional dependencies</div><ul><li><p><a href=https://asciidoctor.org/>Asciidoctor</a></ul></div></div></div><div class=sect1><h2 id=_building_from_source><a class=anchor href=#_building_from_source></a>Building from source</h2><div class=sectionbody><div class=listingblock><div class=title>To clone the repository</div><div class=content><pre class="highlightjs highlight"><code class="language-sh hljs" data-lang=sh>git clone https://github.com/sorairolake/scryptenc-rs.git
 cd scryptenc-rs</code></pre></div></div><div class=listingblock><div class=title>To build a package</div><div class=content><pre class="highlightjs highlight"><code class="language-sh hljs" data-lang=sh>just build</code></pre></div></div><div class=listingblock><div class=title>To find the directory where manual pages are generated</div><div class=content><pre class="highlightjs highlight"><code class="language-sh hljs" data-lang=sh>fd -t directory out ./target/*/build/scryptenc-cli-*</code></pre></div></div></div></div><div class=sect1><h2 id=_crate_features><a class=anchor href=#_crate_features></a>Crate features</h2><div class=sectionbody><div class=dlist><dl><dt class=hdlist1><code>json</code><dd><p>Enable outputting the encryption parameters as JSON. This is enabled by
 default.</dl></div></div></div></article></div></main></div><footer class=footer><p>&copy; 2022&ndash;2024 Shun Sakai &#183; <a href=https://creativecommons.org/licenses/by/4.0/ target=_blank>CC BY 4.0</a><p>Powered by <a href=https://antora.org/ target=_blank>Antora</a> & <a href=https://gitlab.com/antora/antora-ui-default target=_blank>Antora Default UI</a></footer><script id=site-script src=../../_/js/site.js data-ui-root-path=../../_></script><script async src=../../_/js/vendor/highlight.js></script><script src=../../_/js/vendor/lunr.js></script><script src=../../_/js/search-ui.js id=search-ui-script data-site-root-path=../.. data-snippet-length=100 data-stylesheet=../../_/css/search.css></script><script async src=../../search-index.js></script>