Skip to content

Commit 02be1df

Browse files
sylvestresylvestre
committed
deploy: c249eba 
1 parent 304e85f commit 02be1df

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

109 files changed

+3768
-2
lines changed

‎user/print.html

Lines changed: 1883 additions & 0 deletions
Large diffs are not rendered by default.

‎user/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎user/searchindex.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎user/utils/arch.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,14 @@ <h2 id="options"><a class="header" href="#options">Options</a></h2>
190190
<p>Print version information</p>
191191
</dd>
192192
</dl>
193+
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
194+
<p>Display the system's architecture:</p>
195+
<pre><code class="language-shell">arch
196+
</code></pre>
197+
<blockquote>
198+
<p>The examples are provided by the <a href="https://tldr.sh">tldr-pages project</a> under the <a href="https://github.com/tldr-pages/tldr/blob/main/LICENSE.md">CC BY 4.0 License</a>.</p>
199+
<p>Please note that, as uutils is a work in progress, some examples might fail.</p>
200+
</blockquote>
193201

194202
</main>
195203

‎user/utils/b2sum.html

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,29 @@ <h2 id="options"><a class="header" href="#options">Options</a></h2>
225225
<dd>
226226
</dd>
227227
</dl>
228+
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
229+
<p>Calculate the BLAKE2 checksum for a file:</p>
230+
<pre><code class="language-shell">b2sum {{path/to/file}}
231+
</code></pre>
232+
<p>Calculate BLAKE2 checksums for multiple files:</p>
233+
<pre><code class="language-shell">b2sum {{path/to/file1}} {{path/to/file2}}
234+
</code></pre>
235+
<p>Calculate the BLAKE2 checksum from stdin:</p>
236+
<pre><code class="language-shell">{{some_command}} | b2sum
237+
</code></pre>
238+
<p>Read a file of BLAKE2 sums and filenames and verify all files have matching checksums:</p>
239+
<pre><code class="language-shell">b2sum --check {{path/to/file.b2}}
240+
</code></pre>
241+
<p>Only show a message for missing files or when verification fails:</p>
242+
<pre><code class="language-shell">b2sum --check --quiet {{path/to/file.b2}}
243+
</code></pre>
244+
<p>Only show a message for files for which verification fails, ignoring missing files:</p>
245+
<pre><code class="language-shell">b2sum --ignore-missing --check --quiet {{path/to/file.b2}}
246+
</code></pre>
247+
<blockquote>
248+
<p>The examples are provided by the <a href="https://tldr.sh">tldr-pages project</a> under the <a href="https://github.com/tldr-pages/tldr/blob/main/LICENSE.md">CC BY 4.0 License</a>.</p>
249+
<p>Please note that, as uutils is a work in progress, some examples might fail.</p>
250+
</blockquote>
228251

229252
</main>
230253

‎user/utils/base32.html

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,23 @@ <h2 id="options"><a class="header" href="#options">Options</a></h2>
210210
<dd>
211211
</dd>
212212
</dl>
213+
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
214+
<p>Encode a file:</p>
215+
<pre><code class="language-shell">base32 {{filename}}
216+
</code></pre>
217+
<p>Decode a file:</p>
218+
<pre><code class="language-shell">base32 --decode {{filename}}
219+
</code></pre>
220+
<p>Encode from stdin:</p>
221+
<pre><code class="language-shell">{{somecommand}} | base32
222+
</code></pre>
223+
<p>Decode from stdin:</p>
224+
<pre><code class="language-shell">{{somecommand}} | base32 --decode
225+
</code></pre>
226+
<blockquote>
227+
<p>The examples are provided by the <a href="https://tldr.sh">tldr-pages project</a> under the <a href="https://github.com/tldr-pages/tldr/blob/main/LICENSE.md">CC BY 4.0 License</a>.</p>
228+
<p>Please note that, as uutils is a work in progress, some examples might fail.</p>
229+
</blockquote>
213230

214231
</main>
215232

‎user/utils/base64.html

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,23 @@ <h2 id="options"><a class="header" href="#options">Options</a></h2>
210210
<dd>
211211
</dd>
212212
</dl>
213+
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
214+
<p>Encode the contents of a file as base64 and write the result to stdout:</p>
215+
<pre><code class="language-shell">base64 {{filename}}
216+
</code></pre>
217+
<p>Decode the base64 contents of a file and write the result to stdout:</p>
218+
<pre><code class="language-shell">base64 --decode {{filename}}
219+
</code></pre>
220+
<p>Encode from stdin:</p>
221+
<pre><code class="language-shell">{{somecommand}} | base64
222+
</code></pre>
223+
<p>Decode from stdin:</p>
224+
<pre><code class="language-shell">{{somecommand}} | base64 --decode
225+
</code></pre>
226+
<blockquote>
227+
<p>The examples are provided by the <a href="https://tldr.sh">tldr-pages project</a> under the <a href="https://github.com/tldr-pages/tldr/blob/main/LICENSE.md">CC BY 4.0 License</a>.</p>
228+
<p>Please note that, as uutils is a work in progress, some examples might fail.</p>
229+
</blockquote>
213230

214231
</main>
215232

‎user/utils/basename.html

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,20 @@ <h2 id="options"><a class="header" href="#options">Options</a></h2>
207207
<p>end each output line with NUL, not newline</p>
208208
</dd>
209209
</dl>
210+
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
211+
<p>Show only the file name from a path:</p>
212+
<pre><code class="language-shell">basename {{path/to/file}}
213+
</code></pre>
214+
<p>Show only the rightmost directory name from a path:</p>
215+
<pre><code class="language-shell">basename {{path/to/directory/}}
216+
</code></pre>
217+
<p>Show only the file name from a path, with a suffix removed:</p>
218+
<pre><code class="language-shell">basename {{path/to/file}} {{suffix}}
219+
</code></pre>
220+
<blockquote>
221+
<p>The examples are provided by the <a href="https://tldr.sh">tldr-pages project</a> under the <a href="https://github.com/tldr-pages/tldr/blob/main/LICENSE.md">CC BY 4.0 License</a>.</p>
222+
<p>Please note that, as uutils is a work in progress, some examples might fail.</p>
223+
</blockquote>
210224

211225
</main>
212226

‎user/utils/cat.html

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,26 @@ <h2 id="options"><a class="header" href="#options">Options</a></h2>
230230
<p>use ^ and M- notation, except for LF (\n) and TAB (\t)</p>
231231
</dd>
232232
</dl>
233+
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
234+
<p>Print the contents of a file to the standard output:</p>
235+
<pre><code class="language-shell">cat {{file}}
236+
</code></pre>
237+
<p>Concatenate several files into the target file:</p>
238+
<pre><code class="language-shell">cat {{file1}} {{file2}} &gt; {{target_file}}
239+
</code></pre>
240+
<p>Append several files into the target file:</p>
241+
<pre><code class="language-shell">cat {{file1}} {{file2}} &gt;&gt; {{target_file}}
242+
</code></pre>
243+
<p>Number all output lines:</p>
244+
<pre><code class="language-shell">cat -n {{file}}
245+
</code></pre>
246+
<p>Display non-printable and whitespace characters (with <code>M-</code> prefix if non-ASCII):</p>
247+
<pre><code class="language-shell">cat -v -t -e {{file}}
248+
</code></pre>
249+
<blockquote>
250+
<p>The examples are provided by the <a href="https://tldr.sh">tldr-pages project</a> under the <a href="https://github.com/tldr-pages/tldr/blob/main/LICENSE.md">CC BY 4.0 License</a>.</p>
251+
<p>Please note that, as uutils is a work in progress, some examples might fail.</p>
252+
</blockquote>
233253

234254
</main>
235255

‎user/utils/chcon.html

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,32 @@ <h2 id="options"><a class="header" href="#options">Options</a></h2>
250250
<dd>
251251
</dd>
252252
</dl>
253+
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
254+
<p>View security context of a file:</p>
255+
<pre><code class="language-shell">ls -lZ {{path/to/file}}
256+
</code></pre>
257+
<p>Change the security context of a target file, using a reference file:</p>
258+
<pre><code class="language-shell">chcon --reference={{reference_file}} {{target_file}}
259+
</code></pre>
260+
<p>Change the full SELinux security context of a file:</p>
261+
<pre><code class="language-shell">chcon {{user}}:{{role}}:{{type}}:{{range/level}} {{filename}}
262+
</code></pre>
263+
<p>Change only the user part of SELinux security context:</p>
264+
<pre><code class="language-shell">chcon -u {{user}} {{filename}}
265+
</code></pre>
266+
<p>Change only the role part of SELinux security context:</p>
267+
<pre><code class="language-shell">chcon -r {{role}} {{filename}}
268+
</code></pre>
269+
<p>Change only the type part of SELinux security context:</p>
270+
<pre><code class="language-shell">chcon -t {{type}} {{filename}}
271+
</code></pre>
272+
<p>Change only the range/level part of SELinux security context:</p>
273+
<pre><code class="language-shell">chcon -l {{range/level}} {{filename}}
274+
</code></pre>
275+
<blockquote>
276+
<p>The examples are provided by the <a href="https://tldr.sh">tldr-pages project</a> under the <a href="https://github.com/tldr-pages/tldr/blob/main/LICENSE.md">CC BY 4.0 License</a>.</p>
277+
<p>Please note that, as uutils is a work in progress, some examples might fail.</p>
278+
</blockquote>
253279

254280
</main>
255281

‎user/utils/chgrp.html

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,23 @@ <h2 id="options"><a class="header" href="#options">Options</a></h2>
240240
<p>traverse every symbolic link to a directory encountered</p>
241241
</dd>
242242
</dl>
243+
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
244+
<p>Change the owner group of a file/directory:</p>
245+
<pre><code class="language-shell">chgrp {{group}} {{path/to/file_or_directory}}
246+
</code></pre>
247+
<p>Recursively change the owner group of a directory and its contents:</p>
248+
<pre><code class="language-shell">chgrp -R {{group}} {{path/to/directory}}
249+
</code></pre>
250+
<p>Change the owner group of a symbolic link:</p>
251+
<pre><code class="language-shell">chgrp -h {{group}} {{path/to/symlink}}
252+
</code></pre>
253+
<p>Change the owner group of a file/directory to match a reference file:</p>
254+
<pre><code class="language-shell">chgrp --reference={{path/to/reference_file}} {{path/to/file_or_directory}}
255+
</code></pre>
256+
<blockquote>
257+
<p>The examples are provided by the <a href="https://tldr.sh">tldr-pages project</a> under the <a href="https://github.com/tldr-pages/tldr/blob/main/LICENSE.md">CC BY 4.0 License</a>.</p>
258+
<p>Please note that, as uutils is a work in progress, some examples might fail.</p>
259+
</blockquote>
243260

244261
</main>
245262

‎user/utils/chmod.html

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,35 @@ <h2 id="options"><a class="header" href="#options">Options</a></h2>
226226
<dd>
227227
</dd>
228228
</dl>
229+
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
230+
<p>Give the [u]ser who owns a file the right to e[x]ecute it:</p>
231+
<pre><code class="language-shell">chmod u+x {{file}}
232+
</code></pre>
233+
<p>Give the [u]ser rights to [r]ead and [w]rite to a file/directory:</p>
234+
<pre><code class="language-shell">chmod u+rw {{file_or_directory}}
235+
</code></pre>
236+
<p>Remove e[x]ecutable rights from the [g]roup:</p>
237+
<pre><code class="language-shell">chmod g-x {{file}}
238+
</code></pre>
239+
<p>Give [a]ll users rights to [r]ead and e[x]ecute:</p>
240+
<pre><code class="language-shell">chmod a+rx {{file}}
241+
</code></pre>
242+
<p>Give [o]thers (not in the file owner's group) the same rights as the [g]roup:</p>
243+
<pre><code class="language-shell">chmod o=g {{file}}
244+
</code></pre>
245+
<p>Remove all rights from [o]thers:</p>
246+
<pre><code class="language-shell">chmod o= {{file}}
247+
</code></pre>
248+
<p>Change permissions recursively giving [g]roup and [o]thers the ability to [w]rite:</p>
249+
<pre><code class="language-shell">chmod -R g+w,o+w {{directory}}
250+
</code></pre>
251+
<p>Recursively give [a]ll users [r]ead permissions to files and e[X]ecute permissions to sub-directories within a directory:</p>
252+
<pre><code class="language-shell">chmod -R a+rX {{directory}}
253+
</code></pre>
254+
<blockquote>
255+
<p>The examples are provided by the <a href="https://tldr.sh">tldr-pages project</a> under the <a href="https://github.com/tldr-pages/tldr/blob/main/LICENSE.md">CC BY 4.0 License</a>.</p>
256+
<p>Please note that, as uutils is a work in progress, some examples might fail.</p>
257+
</blockquote>
229258

230259
</main>
231260

‎user/utils/chown.html

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,26 @@ <h2 id="options"><a class="header" href="#options">Options</a></h2>
245245
<p>output a diagnostic for every file processed</p>
246246
</dd>
247247
</dl>
248+
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
249+
<p>Change the owner user of a file/directory:</p>
250+
<pre><code class="language-shell">chown {{user}} {{path/to/file_or_directory}}
251+
</code></pre>
252+
<p>Change the owner user and group of a file/directory:</p>
253+
<pre><code class="language-shell">chown {{user}}:{{group}} {{path/to/file_or_directory}}
254+
</code></pre>
255+
<p>Recursively change the owner of a directory and its contents:</p>
256+
<pre><code class="language-shell">chown -R {{user}} {{path/to/directory}}
257+
</code></pre>
258+
<p>Change the owner of a symbolic link:</p>
259+
<pre><code class="language-shell">chown -h {{user}} {{path/to/symlink}}
260+
</code></pre>
261+
<p>Change the owner of a file/directory to match a reference file:</p>
262+
<pre><code class="language-shell">chown --reference={{path/to/reference_file}} {{path/to/file_or_directory}}
263+
</code></pre>
264+
<blockquote>
265+
<p>The examples are provided by the <a href="https://tldr.sh">tldr-pages project</a> under the <a href="https://github.com/tldr-pages/tldr/blob/main/LICENSE.md">CC BY 4.0 License</a>.</p>
266+
<p>Please note that, as uutils is a work in progress, some examples might fail.</p>
267+
</blockquote>
248268

249269
</main>
250270

‎user/utils/chroot.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,17 @@ <h2 id="options"><a class="header" href="#options">Options</a></h2>
211211
<dd>
212212
</dd>
213213
</dl>
214+
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
215+
<p>Run command as new root directory:</p>
216+
<pre><code class="language-shell">chroot {{path/to/new/root}} {{command}}
217+
</code></pre>
218+
<p>Specify user and group (ID or name) to use:</p>
219+
<pre><code class="language-shell">chroot --userspec={{user:group}}
220+
</code></pre>
221+
<blockquote>
222+
<p>The examples are provided by the <a href="https://tldr.sh">tldr-pages project</a> under the <a href="https://github.com/tldr-pages/tldr/blob/main/LICENSE.md">CC BY 4.0 License</a>.</p>
223+
<p>Please note that, as uutils is a work in progress, some examples might fail.</p>
224+
</blockquote>
214225

215226
</main>
216227

‎user/utils/cksum.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,14 @@ <h2 id="options"><a class="header" href="#options">Options</a></h2>
193193
<dd>
194194
</dd>
195195
</dl>
196+
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
197+
<p>Display a 32-bit checksum, size in bytes and filename:</p>
198+
<pre><code class="language-shell">cksum {{path/to/file}}
199+
</code></pre>
200+
<blockquote>
201+
<p>The examples are provided by the <a href="https://tldr.sh">tldr-pages project</a> under the <a href="https://github.com/tldr-pages/tldr/blob/main/LICENSE.md">CC BY 4.0 License</a>.</p>
202+
<p>Please note that, as uutils is a work in progress, some examples might fail.</p>
203+
</blockquote>
196204

197205
</main>
198206

‎user/utils/comm.html

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,26 @@ <h2 id="options"><a class="header" href="#options">Options</a></h2>
212212
<dd>
213213
</dd>
214214
</dl>
215+
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
216+
<p>Produce three tab-separated columns: lines only in first file, lines only in second file and common lines:</p>
217+
<pre><code class="language-shell">comm {{file1}} {{file2}}
218+
</code></pre>
219+
<p>Print only lines common to both files:</p>
220+
<pre><code class="language-shell">comm -12 {{file1}} {{file2}}
221+
</code></pre>
222+
<p>Print only lines common to both files, reading one file from stdin:</p>
223+
<pre><code class="language-shell">cat {{file1}} | comm -12 - {{file2}}
224+
</code></pre>
225+
<p>Get lines only found in first file, saving the result to a third file:</p>
226+
<pre><code class="language-shell">comm -23 {{file1}} {{file2}} &gt; {{file1_only}}
227+
</code></pre>
228+
<p>Print lines only found in second file, when the files aren't sorted:</p>
229+
<pre><code class="language-shell">comm -13 &lt;(sort {{file1}}) &lt;(sort {{file2}})
230+
</code></pre>
231+
<blockquote>
232+
<p>The examples are provided by the <a href="https://tldr.sh">tldr-pages project</a> under the <a href="https://github.com/tldr-pages/tldr/blob/main/LICENSE.md">CC BY 4.0 License</a>.</p>
233+
<p>Please note that, as uutils is a work in progress, some examples might fail.</p>
234+
</blockquote>
215235

216236
</main>
217237

‎user/utils/cp.html

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,29 @@ <h2 id="options"><a class="header" href="#options">Options</a></h2>
319319
<dd>
320320
</dd>
321321
</dl>
322+
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
323+
<p>Copy a file to another location:</p>
324+
<pre><code class="language-shell">cp {{path/to/source_file.ext}} {{path/to/target_file.ext}}
325+
</code></pre>
326+
<p>Copy a file into another directory, keeping the filename:</p>
327+
<pre><code class="language-shell">cp {{path/to/source_file.ext}} {{path/to/target_parent_directory}}
328+
</code></pre>
329+
<p>Recursively copy a directory's contents to another location (if the destination exists, the directory is copied inside it):</p>
330+
<pre><code class="language-shell">cp -R {{path/to/source_directory}} {{path/to/target_directory}}
331+
</code></pre>
332+
<p>Copy a directory recursively, in verbose mode (shows files as they are copied):</p>
333+
<pre><code class="language-shell">cp -vR {{path/to/source_directory}} {{path/to/target_directory}}
334+
</code></pre>
335+
<p>Copy text files to another location, in interactive mode (prompts user before overwriting):</p>
336+
<pre><code class="language-shell">cp -i {{*.txt}} {{path/to/target_directory}}
337+
</code></pre>
338+
<p>Follow symbolic links before copying:</p>
339+
<pre><code class="language-shell">cp -L {{link}} {{path/to/target_directory}}
340+
</code></pre>
341+
<blockquote>
342+
<p>The examples are provided by the <a href="https://tldr.sh">tldr-pages project</a> under the <a href="https://github.com/tldr-pages/tldr/blob/main/LICENSE.md">CC BY 4.0 License</a>.</p>
343+
<p>Please note that, as uutils is a work in progress, some examples might fail.</p>
344+
</blockquote>
322345

323346
</main>
324347

‎user/utils/csplit.html

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,26 @@ <h2 id="options"><a class="header" href="#options">Options</a></h2>
224224
<dd>
225225
</dd>
226226
</dl>
227+
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
228+
<p>Split a file at lines 5 and 23:</p>
229+
<pre><code class="language-shell">csplit {{file}} {{5}} {{23}}
230+
</code></pre>
231+
<p>Split a file every 5 lines (this will fail if the total number of lines is not divisible by 5):</p>
232+
<pre><code class="language-shell">csplit {{file}} {{5}} {*}
233+
</code></pre>
234+
<p>Split a file every 5 lines, ignoring exact-division error:</p>
235+
<pre><code class="language-shell">csplit -k {{file}} {{5}} {*}
236+
</code></pre>
237+
<p>Split a file at line 5 and use a custom prefix for the output files:</p>
238+
<pre><code class="language-shell">csplit {{file}} {{5}} -f {{prefix}}
239+
</code></pre>
240+
<p>Split a file at a line matching a regular expression:</p>
241+
<pre><code class="language-shell">csplit {{file}} /{{regular_expression}}/
242+
</code></pre>
243+
<blockquote>
244+
<p>The examples are provided by the <a href="https://tldr.sh">tldr-pages project</a> under the <a href="https://github.com/tldr-pages/tldr/blob/main/LICENSE.md">CC BY 4.0 License</a>.</p>
245+
<p>Please note that, as uutils is a work in progress, some examples might fail.</p>
246+
</blockquote>
227247

228248
</main>
229249

0 commit comments

Comments
 (0)