diff options
| author | dweller <dweller@cabin.digital> | 2024-02-20 21:01:37 +0200 |
|---|---|---|
| committer | dweller <dweller@cabin.digital> | 2024-02-20 21:01:37 +0200 |
| commit | f28f467032e4f77a1ce8efe8103191c9ad2de02b (patch) | |
| tree | 0527178b43ba7b9b5d32398a4ce213edb627b6c7 /page.html | |
| parent | 4e1b48364a9ae304500dbcb910b0d9f108f9202e (diff) | |
add search and page layouts
Diffstat (limited to 'page.html')
| -rw-r--r-- | page.html | 353 |
1 files changed, 353 insertions, 0 deletions
diff --git a/page.html b/page.html new file mode 100644 index 0000000..32fd4aa --- /dev/null +++ b/page.html @@ -0,0 +1,353 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + + <title>Manup               Lonely MAN near You</title> + + <link rel="icon" type="image/png" sizes="128x128" href="imgs/logo-goog.png"/> + <link rel="icon" type="image/png" sizes="32x32" href="imgs/logo-goog32.png"/> + <link rel="icon" type="image/png" sizes="16x16" href="imgs/logo-goog16.png"/> + <!--<link rel="icon" type="image/x-icon" sizes="16x16" href="imgs/logo-goog16.ico"/>--> + + <link rel="stylesheet" href="style/normalize.css"/> + <link rel="stylesheet" href="style/main.css"/> + <link rel="stylesheet" href="style/search.css"/> + <link rel="stylesheet" href="style/man.css"/> + </head> + <body> + <div id="main"> + <header> + <a id="logo" href="/"> + <h1> + <span id="gc-let">L</span> + <span id="gc-me">m</span> + <code id="gc-man">m</code> + <span id="gc-that">t</span> + <span id="gc-for">F</span> + <span id="gc-you">y</span> + </h1> + <div id="version_wrap"> + <span id="version">BETA!</span> + </div> + </a> + <nav id="search_pane"> + <form> + <div id="query_wrap"> + <input id="query" type='text' value='man' name='query' required/> + <button id="mank" type='submit' value='apropos' name='action' title="apropos(1)">-k</button> + <button id="man" type='submit' value='man' name='action' title="Feeling lucky, punk?" class="btn-acc"> + <div id="query_icon"></div> + </button> + </div> + </form> + </nav> + <nav id="topnav"> + <a href="https://cabin.digital">Cabin</a> + <a href="#"><span id="topnav_icon"></span></a> + <button class="btn-acc">Man up</button> + </nav> + </header> + <section id="results"> +<article class="manpage"><p> + </p><div class="head" role="doc-pageheader" aria-label="Manual header + line"><span class="head-ltitle">MAN(1)</span> <span class="head-vol">General + Commands Manual</span> <span class="head-rtitle">MAN(1)</span></div> +<main class="manual-text"> +<section class="Sh"> +<h2 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h2> +<p class="Pp"><code class="Nm">man</code> — + <span class="Nd" role="doc-subtitle">display manual pages</span></p> +</section> +<section class="Sh"> +<h2 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h2> +<table class="Nm"> + <tbody><tr> + <td><code class="Nm">man</code></td> + <td>[<code class="Fl">-acfhklw</code>] [<code class="Fl">-C</code> + <var class="Ar">file</var>] [<code class="Fl">-M</code> + <var class="Ar">path</var>] [<code class="Fl">-m</code> + <var class="Ar">path</var>] [<code class="Fl">-S</code> + <var class="Ar">subsection</var>] [[<code class="Fl">-s</code>] + <var class="Ar">section</var>] <var class="Ar">name ...</var></td> + </tr> +</tbody></table> +</section> +<h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h2> +The <code class="Nm">man</code> utility displays the manual page entitled + <var class="Ar">name</var>. Pages may be selected according to a specific + category (<var class="Ar">section</var>) or machine architecture + (<var class="Ar">subsection</var>). +<p class="Pp">The options are as follows:</p> +<dl class="Bl-tag"> + <dt id="a"><a class="permalink" href="#a"><code class="Fl">-a</code></a></dt> + <dd>Display all matching manual pages.</dd> + <dt id="C"><a class="permalink" href="#C"><code class="Fl">-C</code></a> + <var class="Ar">file</var></dt> + <dd>Use the specified <var class="Ar">file</var> instead of the default + configuration file. This permits users to configure their own manual + environment. See <a class="Xr" aria-label="man.conf, section + 5">man.conf(5)</a> for a description of the contents of this file.</dd> + <dt id="c"><a class="permalink" href="#c"><code class="Fl">-c</code></a></dt> + <dd>Copy the manual page to the standard output instead of using + <a class="Xr" aria-label="less, section 1">less(1)</a> to paginate it. + This is done by default if the standard output is not a terminal device. + <p class="Pp">When using <code class="Fl">-c</code>, most terminal devices + are unable to show the markup. To print the output of + <code class="Nm">man</code> to the terminal with markup but without + using a pager, pipe it to <a class="Xr" aria-label="ul, section + 1">ul(1)</a>. To remove the markup, pipe the output to + <a class="Xr" aria-label="col, section 1">col(1)</a> + <code class="Fl">-b</code> instead.</p> + </dd> + <dt id="f"><a class="permalink" href="#f"><code class="Fl">-f</code></a></dt> + <dd>A synonym for <a class="Xr" aria-label="whatis, section 1">whatis(1)</a>. + It searches for <var class="Ar">name</var> in manual page names and + displays the header lines from all matching pages. The search is case + insensitive and matches whole words only.</dd> + <dt id="h"><a class="permalink" href="#h"><code class="Fl">-h</code></a></dt> + <dd>Display only the SYNOPSIS lines of the requested manual pages. Implies + <code class="Fl">-a</code> and <code class="Fl">-c</code>.</dd> + <dt id="k"><a class="permalink" href="#k"><code class="Fl">-k</code></a></dt> + <dd>A synonym for <a class="Xr" aria-label="apropos, section + 1">apropos(1)</a>. Instead of <var class="Ar">name</var>, an expression + can be provided using the syntax described in the + <a class="Xr" aria-label="apropos, section 1">apropos(1)</a> manual. By + default, it displays the header lines of all matching pages.</dd> + <dt id="l"><a class="permalink" href="#l"><code class="Fl">-l</code></a></dt> + <dd>A synonym for <a class="Xr" aria-label="mandoc, section 1">mandoc(1)</a>. + The <var class="Ar">name</var> arguments are interpreted as filenames. No + search is done and <var class="Ar">file</var>, <var class="Ar">path</var>, + <var class="Ar">section</var>, <var class="Ar">subsection</var>, and + <code class="Fl">-w</code> are ignored. This option implies + <code class="Fl">-a</code>.</dd> + <dt id="M"><a class="permalink" href="#M"><code class="Fl">-M</code></a> + <var class="Ar">path</var></dt> + <dd>Override the list of directories to search for manual pages. The supplied + <var class="Ar">path</var> must be a colon + (‘<code class="Li">:</code>’) separated list of directories. + This option also overrides the environment variable + <code class="Ev">MANPATH</code> and any directories specified in the + <a class="Xr" aria-label="man.conf, section 5">man.conf(5)</a> file.</dd> + <dt id="m"><a class="permalink" href="#m"><code class="Fl">-m</code></a> + <var class="Ar">path</var></dt> + <dd>Augment the list of directories to search for manual pages. The supplied + <var class="Ar">path</var> must be a colon + (‘<code class="Li">:</code>’) separated list of directories. + These directories will be searched before those specified using the + <code class="Fl">-M</code> option, the <code class="Ev">MANPATH</code> + environment variable, the <a class="Xr" aria-label="man.conf, section + 5">man.conf(5)</a> file, or the default directories.</dd> + <dt id="S"><a class="permalink" href="#S"><code class="Fl">-S</code></a> + <var class="Ar">subsection</var></dt> + <dd>Only show pages for the specified <a class="Xr" aria-label="machine, + section 1">machine(1)</a> architecture. <var class="Ar">subsection</var> + is case insensitive. + <p class="Pp">By default manual pages for all architectures are installed. + Therefore this option can be used to view pages for one architecture + whilst using another.</p> + <p class="Pp">This option overrides the <code class="Ev">MACHINE</code> + environment variable.</p> + </dd> + <dt id="s">[<code class="Fl">-s</code>] <var class="Ar">section</var></dt> + <dd>Only select manuals from the specified <var class="Ar">section</var>. The + currently available sections are: + <p class="Pp"></p> + <div class="Bd-indent"> + <dl class="Bl-tag Bl-compact"> + <dt>1</dt> + <dd>General commands (tools and utilities).</dd> + <dt>2</dt> + <dd>System calls and error numbers.</dd> + <dt>3</dt> + <dd>Library functions.</dd> + <dt>3p</dt> + <dd><a class="Xr" aria-label="perl, section 1">perl(1)</a> programmer's + reference guide.</dd> + <dt>4</dt> + <dd>Device drivers.</dd> + <dt>5</dt> + <dd>File formats.</dd> + <dt>6</dt> + <dd>Games.</dd> + <dt>7</dt> + <dd>Miscellaneous information.</dd> + <dt>8</dt> + <dd>System maintenance and operation commands.</dd> + <dt>9</dt> + <dd>Kernel internals.</dd> + </dl> + </div> + </dd> + <dt id="w"><a class="permalink" href="#w"><code class="Fl">-w</code></a></dt> + <dd>List the pathnames of all matching manual pages instead of displaying any + of them. If no <var class="Ar">name</var> is given, list the directories + that would be searched.</dd> +</dl> +<p class="Pp">The options <code class="Fl">-IKOTW</code> are also supported and + are documented in <a class="Xr" aria-label="mandoc, section + 1">mandoc(1)</a>. The options <code class="Fl">-fkl</code> are mutually + exclusive and override each other.</p> +<p class="Pp">The search starts with the <code class="Fl">-m</code> argument if + provided, then continues with the <code class="Fl">-M</code> argument, the + <code class="Ev">MANPATH</code> variable, the + <code class="Ic">manpath</code> entries in the + <a class="Xr" aria-label="man.conf, section 5">man.conf(5)</a> file, or with + <span class="Pa">/usr/share/man</span>:<span class="Pa">/usr/X11R6/man</span>:<span class="Pa">/usr/local/man</span> + by default. Within each of these, directories are searched in the order + provided. Within each directory, the search proceeds according to the + following list of sections: 1, 8, 6, 2, 3, 5, 7, 4, 9, 3p. The first match + found is shown.</p> +<p class="Pp">The <a class="Xr" aria-label="mandoc.db, section + 5">mandoc.db(5)</a> database is used for looking up manual page entries. In + cases where the database is absent, outdated, or corrupt, + <code class="Nm">man</code> falls back to looking for files called + <var class="Ar">name</var>.<var class="Ar">section</var>. If both a + formatted and an unformatted version of the same manual page, for example + <span class="Pa">cat1/foo.0</span> and <span class="Pa">man1/foo.1</span>, + exist in the same directory, only the unformatted version is used. The + database is kept up to date with <a class="Xr" aria-label="makewhatis, + section 8">makewhatis(8)</a>, which is run by the + <a class="Xr" aria-label="weekly, section 8">weekly(8)</a> maintenance + script.</p> +<p class="Pp">Guidelines for writing man pages can be found in + <a class="Xr" aria-label="mdoc, section 7">mdoc(7)</a>.</p> +<section class="Sh"> +<h2 class="Sh" id="ENVIRONMENT"><a class="permalink" href="#ENVIRONMENT">ENVIRONMENT</a></h2> +<dl class="Bl-tag"> + <dt id="MACHINE"><a class="permalink" href="#MACHINE"><code class="Ev">MACHINE</code></a></dt> + <dd>As some manual pages are intended only for specific architectures, + <code class="Nm">man</code> searches any subdirectories, with the same + name as the current architecture, in every directory which it searches. + Machine specific areas are checked before general areas. The current + machine type may be overridden by setting the environment variable + <code class="Ev">MACHINE</code> to the name of a specific architecture, or + with the <code class="Fl">-S</code> option. + <code class="Ev">MACHINE</code> is case insensitive.</dd> + <dt id="MANPAGER"><a class="permalink" href="#MANPAGER"><code class="Ev">MANPAGER</code></a></dt> + <dd>Any non-empty value of the environment variable + <code class="Ev">MANPAGER</code> is used instead of the standard + pagination program, <a class="Xr" aria-label="less, section + 1">less(1)</a>. If <a class="Xr" aria-label="less, section 1">less(1)</a> + is used, the interactive <code class="Ic">:t</code> command can be used to + go to the definitions of various terms, for example command line options, + command modifiers, internal commands, environment variables, function + names, preprocessor macros, <a class="Xr" aria-label="errno, section + 2">errno(2)</a> values, and some other emphasized words. Some terms may + have defining text at more than one place. In that case, the + <a class="Xr" aria-label="less, section 1">less(1)</a> interactive + commands <code class="Ic">t</code> and <code class="Ic">T</code> can be + used to move to the next and to the previous place providing information + about the term last searched for with <code class="Ic">:t</code>. The + <code class="Fl">-O</code> + <code class="Cm">tag</code>[=<var class="Ar">term</var>] option documented + in the <a class="Xr" aria-label="mandoc, section 1">mandoc(1)</a> manual + opens a manual page at the definition of a specific + <var class="Ar">term</var> rather than at the beginning.</dd> + <dt id="MANPATH"><a class="permalink" href="#MANPATH"><code class="Ev">MANPATH</code></a></dt> + <dd>Override the standard search path which is either specified in + <a class="Xr" aria-label="man.conf, section 5">man.conf(5)</a> or the + default path. The format of <code class="Ev">MANPATH</code> is a colon + (‘<code class="Li">:</code>’) separated list of directories. + Invalid directories are ignored. Overridden by <code class="Fl">-M</code>, + ignored if <code class="Fl">-l</code> is specified. + <p class="Pp">If <code class="Ev">MANPATH</code> begins with a colon, it is + appended to the standard path; if it ends with a colon, it is prepended + to the standard path; or if it contains two adjacent colons, the + standard path is inserted between the colons.</p> + </dd> + <dt id="PAGER"><a class="permalink" href="#PAGER"><code class="Ev">PAGER</code></a></dt> + <dd>Specifies the pagination program to use when + <code class="Ev">MANPAGER</code> is not defined. If neither PAGER nor + MANPAGER is defined, <a class="Xr" aria-label="less, section + 1">less(1)</a> is used.</dd> +</dl> +</section> +<section class="Sh"> +<h2 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h2> +<dl class="Bl-tag Bl-compact"> + <dt><span class="Pa">/etc/man.conf</span></dt> + <dd>default <code class="Nm">man</code> configuration file</dd> +</dl> +</section> +<section class="Sh"> +<h2 class="Sh" id="EXIT_STATUS"><a class="permalink" href="#EXIT_STATUS">EXIT + STATUS</a></h2> +<p class="Pp">The <code class="Nm">man</code> utility exits 0 on success, + and >0 if an error occurs. See <a class="Xr" aria-label="mandoc, + section 1">mandoc(1)</a> for details.</p> +</section> +<section class="Sh"> +<h2 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h2> +<p class="Pp">Format a page for pasting extracts into an email message — + avoid printing any UTF-8 characters, reduce the width to ease quoting in + replies, and remove markup:</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">$ man -T ascii -O width=65 pledge | + col -b</code></div> +<p class="Pp">Read a typeset page in a PDF viewer:</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">$ MANPAGER=mupdf man -T pdf + lpd</code></div> +</section> +<section class="Sh"> +<h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h2> +<p class="Pp"><a class="Xr" aria-label="apropos, section 1">apropos(1)</a>, + <a class="Xr" aria-label="col, section 1">col(1)</a>, + <a class="Xr" aria-label="mandoc, section 1">mandoc(1)</a>, + <a class="Xr" aria-label="ul, section 1">ul(1)</a>, + <a class="Xr" aria-label="whereis, section 1">whereis(1)</a>, + <a class="Xr" aria-label="man.conf, section 5">man.conf(5)</a>, + <a class="Xr" aria-label="mdoc, section 7">mdoc(7)</a></p> +</section> +<section class="Sh"> +<h2 class="Sh" id="STANDARDS"><a class="permalink" href="#STANDARDS">STANDARDS</a></h2> +<p class="Pp">The <code class="Nm">man</code> utility is compliant with the + <span class="St">IEEE Std 1003.1-2008 (“POSIX.1”)</span> + specification.</p> +<p class="Pp">The flags [<code class="Fl">-aCcfhIKlMmOSsTWw</code>], as well as + the environment variables <code class="Ev">MACHINE</code>, + <code class="Ev">MANPAGER</code>, and <code class="Ev">MANPATH</code>, are + extensions to that specification.</p> +</section> +<section class="Sh"> +<h2 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h2> +<p class="Pp">A <code class="Nm">man</code> command first appeared in + <span class="Ux">Version 2 AT&T UNIX</span>.</p> +<p class="Pp">The <code class="Fl">-w</code> option first appeared in + <span class="Ux">Version 7 AT&T UNIX</span>; + <code class="Fl">-f</code> and <code class="Fl">-k</code> in + <span class="Pa">/usr/usb/man</span> in <span class="Ux">4.0BSD</span>; + <code class="Fl">-M</code> in <span class="Ux">4.3BSD</span>; + <code class="Fl">-a</code> in <span class="Ux">4.3BSD-Tahoe</span>; + <code class="Fl">-c</code> and <code class="Fl">-m</code> in + <span class="Ux">4.3BSD-Reno</span>; <code class="Fl">-h</code> in + <span class="Ux">4.3BSD-Net/2</span>; <code class="Fl">-C</code> in + <span class="Ux">NetBSD 1.0</span>; <code class="Fl">-s</code> and + <code class="Fl">-S</code> in <span class="Ux">OpenBSD 2.3</span>; and + <code class="Fl">-I</code>, <code class="Fl">-K</code>, + <code class="Fl">-l</code>, <code class="Fl">-O</code>, and + <code class="Fl">-W</code> in <span class="Ux">OpenBSD 5.7</span>. The + <code class="Fl">-T</code> option first appeared in + <span class="Ux">AT&T System III UNIX</span> and was also added + in <span class="Ux">OpenBSD 5.7</span>.</p> +</section> +</main> +<div class="foot" role="doc-pagefooter" aria-label="Manual footer + line"><span class="foot-left"></span><span class="foot-date">August 4, + 2022</span> <span class="foot-os">Linux 5.10.0-28-cloud-amd64</span></div> + <p></p></article> + </section> + <footer> + <p class="center"> + Copyleft <span class="copyleft">©</span> 2024 + <a href="mailto:manup@cabin.digital">dweller</a> from + <a href="https://cabin.digital">cabin.digital</a>. + All Wrongs Reserved. + </p> + </footer> + </div> + </body> +</html> |