ceos/tealdeer
1
0
Fork 0
mirror of https://github.com/tealdeer-rs/tealdeer.git synced 2026-08-24 00:54:17 +02:00
Code Issues Projects Releases Packages Wiki Activity

deploy: 84621cda81

Browse source
This commit is contained in:
dbrgn 2023-02-12 18:07:44 +00:00
commit cadea84106
9 changed files with 29 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

6
config.html
View file

@ -206,12 +206,6 @@ auto_update = true
<p>The directory where the configuration file resides may be overwritten by the
environment variable <code>TEALDEER_CONFIG_DIR</code>. Remember to use an absolute path.
Variable expansion will not be performed on the path.</p>
<h2><a class="header" href="#override-cache-directory" id="override-cache-directory">Override Cache Directory</a></h2>
<p>Similarly, the cache directory where the pages are downloaded to, also follows
OS conventions. On Linux, it will usually be at <code>~/.cache/tealdeer/</code>. The path
can be overwritten using the environment variable <code>TEALDEER_CACHE_DIR</code>.
Remember to use an absolute path. Variable expansion will not be performed on
the path.</p>
</main>

4
config_style.html
View file

@ -191,13 +191,13 @@
</code></pre>
</li>
<li>
<p>256 color ANSI code (<em>Tealdeer v1.5.0+</em>)</p>
<p>256 color ANSI code (<em>tealdeer v1.5.0+</em>)</p>
<p>Example:</p>
<pre><code>foreground = { ansi = 4 }
</code></pre>
</li>
<li>
<p>24-bit RGB color (<em>Tealdeer v1.5.0+</em>)</p>
<p>24-bit RGB color (<em>tealdeer v1.5.0+</em>)</p>
<p>Example:</p>
<pre><code>background = { rgb = { r = 255, g = 255, b = 255 } }
</code></pre>

2
config_updates.html
View file

@ -165,7 +165,7 @@
<main>
<h1><a class="header" href="#section-updates" id="section-updates">Section: [updates]</a></h1>
<h2><a class="header" href="#automatic-updates" id="automatic-updates">Automatic updates</a></h2>
<p>tealdeer can refresh the cache automatically when it is outdated. This
<p>Tealdeer can refresh the cache automatically when it is outdated. This
behavior can be configured in the <code>updates</code> section and is disabled by
default.</p>
<h3><a class="header" href="#auto_update" id="auto_update"><code>auto_update</code></a></h3>

2
index.html
View file

@ -168,7 +168,7 @@
<a href="https://github.com/tldr-pages/tldr">tldr</a> in Rust: Simplified, example based
and community-driven man pages.</p>
<p><img src="screenshot-default.png" alt="Screenshot" /></p>
<p>This documentation shows how to install, use and configure Tealdeer.</p>
<p>This documentation shows how to install, use and configure tealdeer.</p>
<h2><a class="header" href="#links" id="links">Links</a></h2>
<ul>
<li><a href="https://github.com/dbrgn/tealdeer">GitHub Project Page</a></li>

20
installing.html
View file

@ -164,7 +164,7 @@
<div id="content" class="content">
<main>
<h1><a class="header" href="#installing" id="installing">Installing</a></h1>
<p>There are a few different ways to install Tealdeer:</p>
<p>There are a few different ways to install tealdeer:</p>
<ul>
<li>Through <a href="#package-managers">package managers</a></li>
<li>Through <a href="#static-binaries-linux">static binaries</a></li>
@ -198,21 +198,19 @@ Simply download the binary for your platform and run it!</p>
<p>Build and install the tool via cargo...</p>
<pre><code>$ cargo install tealdeer
</code></pre>
<p><em>(Note: You might need to install OpenSSL development headers, otherwise you get
a &quot;failed to run custom build command for openssl-sys&quot; error message. The
package is called <code>libssl-dev</code> on Ubuntu.)</em></p>
<h2><a class="header" href="#build-from-source" id="build-from-source">Build From Source</a></h2>
<p>Debug build with logging enabled:</p>
<pre><code>$ cargo build --features logging
</code></pre>
<p>Release build without logging:</p>
<p>Release build:</p>
<pre><code>$ cargo build --release
</code></pre>
<p>To enable the log output, set the <code>RUST_LOG</code> env variable:</p>
<pre><code>$ export RUST_LOG=tldr=debug
<p>Release build with bundled CA roots:</p>
<pre><code>$ cargo build --release --no-default-features --features webpki-roots
</code></pre>
<p>Debug build with logging support:</p>
<pre><code>$ cargo build --features logging
</code></pre>
<p>(To enable logging at runtime, export the <code>RUST_LOG=tldr=debug</code> env variable.)</p>
<h2><a class="header" href="#autocompletion" id="autocompletion">Autocompletion</a></h2>
<p>Shell completion scripts are located in the folder <code>completion</code>.
<p>Shell completion scripts are located in the folder <code>completion</code>.
Just copy them to their designated location:</p>
<ul>
<li><em>Bash</em>: <code>cp completion/bash_tealdeer /usr/share/bash-completion/completions/tldr</code></li>

2
intro.html
View file

@ -168,7 +168,7 @@
<a href="https://github.com/tldr-pages/tldr">tldr</a> in Rust: Simplified, example based
and community-driven man pages.</p>
<p><img src="screenshot-default.png" alt="Screenshot" /></p>
<p>This documentation shows how to install, use and configure Tealdeer.</p>
<p>This documentation shows how to install, use and configure tealdeer.</p>
<h2><a class="header" href="#links" id="links">Links</a></h2>
<ul>
<li><a href="https://github.com/dbrgn/tealdeer">GitHub Project Page</a></li>

34
print.html
View file

@ -170,14 +170,14 @@
<a href="https://github.com/tldr-pages/tldr">tldr</a> in Rust: Simplified, example based
and community-driven man pages.</p>
<p><img src="screenshot-default.png" alt="Screenshot" /></p>
<p>This documentation shows how to install, use and configure Tealdeer.</p>
<p>This documentation shows how to install, use and configure tealdeer.</p>
<h2><a class="header" href="#links" id="links">Links</a></h2>
<ul>
<li><a href="https://github.com/dbrgn/tealdeer">GitHub Project Page</a></li>
<li><a href="https://tldr.sh/">TLDR Pages Project</a></li>
</ul>
<h1><a class="header" href="#installing" id="installing">Installing</a></h1>
<p>There are a few different ways to install Tealdeer:</p>
<p>There are a few different ways to install tealdeer:</p>
<ul>
<li>Through <a href="installing.html#package-managers">package managers</a></li>
<li>Through <a href="installing.html#static-binaries-linux">static binaries</a></li>
@ -211,21 +211,19 @@ Simply download the binary for your platform and run it!</p>
<p>Build and install the tool via cargo...</p>
<pre><code>$ cargo install tealdeer
</code></pre>
<p><em>(Note: You might need to install OpenSSL development headers, otherwise you get
a &quot;failed to run custom build command for openssl-sys&quot; error message. The
package is called <code>libssl-dev</code> on Ubuntu.)</em></p>
<h2><a class="header" href="#build-from-source" id="build-from-source">Build From Source</a></h2>
<p>Debug build with logging enabled:</p>
<pre><code>$ cargo build --features logging
</code></pre>
<p>Release build without logging:</p>
<p>Release build:</p>
<pre><code>$ cargo build --release
</code></pre>
<p>To enable the log output, set the <code>RUST_LOG</code> env variable:</p>
<pre><code>$ export RUST_LOG=tldr=debug
<p>Release build with bundled CA roots:</p>
<pre><code>$ cargo build --release --no-default-features --features webpki-roots
</code></pre>
<p>Debug build with logging support:</p>
<pre><code>$ cargo build --features logging
</code></pre>
<p>(To enable logging at runtime, export the <code>RUST_LOG=tldr=debug</code> env variable.)</p>
<h2><a class="header" href="#autocompletion" id="autocompletion">Autocompletion</a></h2>
<p>Shell completion scripts are located in the folder <code>completion</code>.
<p>Shell completion scripts are located in the folder <code>completion</code>.
Just copy them to their designated location:</p>
<ul>
<li><em>Bash</em>: <code>cp completion/bash_tealdeer /usr/share/bash-completion/completions/tldr</code></li>
@ -340,12 +338,6 @@ auto_update = true
<p>The directory where the configuration file resides may be overwritten by the
environment variable <code>TEALDEER_CONFIG_DIR</code>. Remember to use an absolute path.
Variable expansion will not be performed on the path.</p>
<h2><a class="header" href="#override-cache-directory" id="override-cache-directory">Override Cache Directory</a></h2>
<p>Similarly, the cache directory where the pages are downloaded to, also follows
OS conventions. On Linux, it will usually be at <code>~/.cache/tealdeer/</code>. The path
can be overwritten using the environment variable <code>TEALDEER_CACHE_DIR</code>.
Remember to use an absolute path. Variable expansion will not be performed on
the path.</p>
<h1><a class="header" href="#section-display" id="section-display">Section: [display]</a></h1>
<p>In the <code>display</code> section you can configure the output format.</p>
<h2><a class="header" href="#use_pager" id="use_pager"><code>use_pager</code></a></h2>
@ -390,13 +382,13 @@ compact = true
</code></pre>
</li>
<li>
<p>256 color ANSI code (<em>Tealdeer v1.5.0+</em>)</p>
<p>256 color ANSI code (<em>tealdeer v1.5.0+</em>)</p>
<p>Example:</p>
<pre><code>foreground = { ansi = 4 }
</code></pre>
</li>
<li>
<p>24-bit RGB color (<em>Tealdeer v1.5.0+</em>)</p>
<p>24-bit RGB color (<em>tealdeer v1.5.0+</em>)</p>
<p>Example:</p>
<pre><code>background = { rgb = { r = 255, g = 255, b = 255 } }
</code></pre>
@ -404,7 +396,7 @@ compact = true
</ul>
<h1><a class="header" href="#section-updates" id="section-updates">Section: [updates]</a></h1>
<h2><a class="header" href="#automatic-updates" id="automatic-updates">Automatic updates</a></h2>
<p>tealdeer can refresh the cache automatically when it is outdated. This
<p>Tealdeer can refresh the cache automatically when it is outdated. This
behavior can be configured in the <code>updates</code> section and is disabled by
default.</p>
<h3><a class="header" href="#auto_update" id="auto_update"><code>auto_update</code></a></h3>

2
searchindex.js
View file

File diff suppressed because one or more lines are too long

2
searchindex.json
View file

File diff suppressed because one or more lines are too long