auxolotl/docs
26
0
Fork 1
mirror of https://git.gay/pyrox/aux-docs synced 2024-10-30 07:27:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
docs/NixOS/documentation/index.html

6631 lines
121 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Aux Documentation">
<meta name="author" content="Nixpkgs Aux, and Lix Contributors">
<link rel="canonical" href="https://docs.auxolotl.org/NixOS/documentation/">
<link rel="prev" href="../containers/">
<link rel="next" href="../dysnomia/">
<link rel="icon" href="../../assets/aux-logo.svg">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.29">
<title>Documentation - Aux Docs</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.76a95c52.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.bunny.net/css?family=IBM+Plex+Sans:300,300i,400,400i,700,700i%7CIBM+Plex+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"IBM Plex Sans";--md-code-font:"IBM Plex Mono"}</style>
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<meta property="og:type" content="website" >
<meta property="og:title" content="Documentation - Aux Docs" >
<meta property="og:description" content="Aux Documentation" >
<meta property="og:image" content="https://docs.auxolotl.org/assets/images/social/NixOS/documentation.png" >
<meta property="og:image:type" content="image/png" >
<meta property="og:image:width" content="1200" >
<meta property="og:image:height" content="630" >
<meta property="og:url" content="https://docs.auxolotl.org/NixOS/documentation/" >
<meta name="twitter:card" content="summary_large_image" >
<meta name="twitter:title" content="Documentation - Aux Docs" >
<meta name="twitter:description" content="Aux Documentation" >
<meta name="twitter:image" content="https://docs.auxolotl.org/assets/images/social/NixOS/documentation.png" >
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="blue">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#documentationdevenable" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="Aux Docs" class="md-header__button md-logo" aria-label="Aux Docs" data-md-component="logo">
<img src="../../assets/aux-logo.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Aux Docs
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Documentation
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="blue" aria-label="Dark Mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Dark Mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="blue" aria-label="Light Mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Light Mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5c-.84 0-1.65.15-2.39.42L12 2M3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29L3.34 7m.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14L3.36 17M20.65 7l-1.77 3.79a7.023 7.023 0 0 0-2.38-4.15l4.15.36m-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29L20.64 17M12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44L12 22Z"/></svg>
</label>
</form>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://git.auxolotl.org/auxolotl/docs" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.777 0a2.9 2.9 0 1 1-2.529 4.322H12.91a4.266 4.266 0 0 0-4.265 4.195v2.118a7.076 7.076 0 0 1 4.147-1.42l.118-.002h1.338a2.9 2.9 0 0 1 5.43 1.422 2.9 2.9 0 0 1-5.43 1.422H12.91a4.266 4.266 0 0 0-4.265 4.195v2.319A2.9 2.9 0 0 1 7.222 24 2.9 2.9 0 0 1 5.8 18.57V8.589a7.109 7.109 0 0 1 6.991-7.108l.118-.001h1.338A2.9 2.9 0 0 1 16.778 0ZM7.223 19.905a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Zm9.554-10.464a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.39Zm0-7.735a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Z"/></svg>
</div>
<div class="md-source__repository">
auxolotl/docs
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Aux Documentation Hub
</a>
</li>
<li class="md-tabs__item">
<a href="../../TODO/" class="md-tabs__link">
TODO
</a>
</li>
<li class="md-tabs__item">
<a href="../../Aux/" class="md-tabs__link">
Aux
</a>
</li>
<li class="md-tabs__item">
<a href="../../Lix/" class="md-tabs__link">
Lix
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../appstream/" class="md-tabs__link">
NixOS
</a>
</li>
<li class="md-tabs__item">
<a href="../../Nixpkgs/" class="md-tabs__link">
Nixpkgs
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="Aux Docs" class="md-nav__button md-logo" aria-label="Aux Docs" data-md-component="logo">
<img src="../../assets/aux-logo.svg" alt="logo">
</a>
Aux Docs
</label>
<div class="md-nav__source">
<a href="https://git.auxolotl.org/auxolotl/docs" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.777 0a2.9 2.9 0 1 1-2.529 4.322H12.91a4.266 4.266 0 0 0-4.265 4.195v2.118a7.076 7.076 0 0 1 4.147-1.42l.118-.002h1.338a2.9 2.9 0 0 1 5.43 1.422 2.9 2.9 0 0 1-5.43 1.422H12.91a4.266 4.266 0 0 0-4.265 4.195v2.319A2.9 2.9 0 0 1 7.222 24 2.9 2.9 0 0 1 5.8 18.57V8.589a7.109 7.109 0 0 1 6.991-7.108l.118-.001h1.338A2.9 2.9 0 0 1 16.778 0ZM7.223 19.905a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Zm9.554-10.464a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.39Zm0-7.735a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Z"/></svg>
</div>
<div class="md-source__repository">
auxolotl/docs
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Aux Documentation Hub
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../TODO/" class="md-nav__link">
<span class="md-ellipsis">
TODO
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Aux/" class="md-nav__link">
<span class="md-ellipsis">
Aux
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Lix/" class="md-nav__link">
<span class="md-ellipsis">
Lix
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<span class="md-ellipsis">
NixOS
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
NixOS
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../appstream/" class="md-nav__link">
<span class="md-ellipsis">
Appstream
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../console/" class="md-nav__link">
<span class="md-ellipsis">
Console
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../containers/" class="md-nav__link">
<span class="md-ellipsis">
Containers
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Documentation
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Documentation
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#documentationdevenable" class="md-nav__link">
<span class="md-ellipsis">
documentation.dev.enable
</span>
</a>
<nav class="md-nav" aria-label="documentation.dev.enable">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationdocenable" class="md-nav__link">
<span class="md-ellipsis">
documentation.doc.enable
</span>
</a>
<nav class="md-nav" aria-label="documentation.doc.enable">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_1" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationenable" class="md-nav__link">
<span class="md-ellipsis">
documentation.enable
</span>
</a>
<nav class="md-nav" aria-label="documentation.enable">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_2" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationinfoenable" class="md-nav__link">
<span class="md-ellipsis">
documentation.info.enable
</span>
</a>
<nav class="md-nav" aria-label="documentation.info.enable">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_3" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanenable" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.enable
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.enable">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_4" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmangeneratecaches" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.generateCaches
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.generateCaches">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_5" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanman-dbenable" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.man-db.enable
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.man-db.enable">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_6" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanman-dbmanualpages" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.man-db.manualPages
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.man-db.manualPages">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_7" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanman-dbpackage" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.man-db.package
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.man-db.package">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_8" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandoccachepath" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.cachePath
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.cachePath">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_9" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_1" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocenable" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.enable
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.enable">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_10" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_2" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocextraconfig" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.extraConfig
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.extraConfig">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_11" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocmanpath" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.manPath
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.manPath">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_12" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_3" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocpackage" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.package
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.package">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_13" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettings" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_14" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsmanpath" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.manpath
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.manpath">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_15" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_4" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsoutputfragment" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.output.fragment
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.output.fragment">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_16" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_5" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsoutputincludes" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.output.includes
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.output.includes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_17" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_6" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsoutputindent" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.output.indent
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.output.indent">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_18" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsoutputman" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.output.man
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.output.man">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_19" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_7" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsoutputpaper" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.output.paper
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.output.paper">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_20" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsoutputstyle" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.output.style
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.output.style">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_21" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsoutputtoc" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.output.toc
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.output.toc">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_22" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_8" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsoutputwidth" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.output.width
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.output.width">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_23" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationnixosenable" class="md-nav__link">
<span class="md-ellipsis">
documentation.nixos.enable
</span>
</a>
<nav class="md-nav" aria-label="documentation.nixos.enable">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_24" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationnixosextramodulesources" class="md-nav__link">
<span class="md-ellipsis">
documentation.nixos.extraModuleSources
</span>
</a>
<nav class="md-nav" aria-label="documentation.nixos.extraModuleSources">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_25" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_9" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationnixosextramodules" class="md-nav__link">
<span class="md-ellipsis">
documentation.nixos.extraModules
</span>
</a>
<nav class="md-nav" aria-label="documentation.nixos.extraModules">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_26" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationnixosincludeallmodules" class="md-nav__link">
<span class="md-ellipsis">
documentation.nixos.includeAllModules
</span>
</a>
<nav class="md-nav" aria-label="documentation.nixos.includeAllModules">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_27" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationnixosoptionssplitbuild" class="md-nav__link">
<span class="md-ellipsis">
documentation.nixos.options.splitBuild
</span>
</a>
<nav class="md-nav" aria-label="documentation.nixos.options.splitBuild">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_28" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationnixosoptionswarningsareerrors" class="md-nav__link">
<span class="md-ellipsis">
documentation.nixos.options.warningsAreErrors
</span>
</a>
<nav class="md-nav" aria-label="documentation.nixos.options.warningsAreErrors">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_29" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../dysnomia/" class="md-nav__link">
<span class="md-ellipsis">
Dysnomia
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../ec2/" class="md-nav__link">
<span class="md-ellipsis">
Ec2
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../environment/" class="md-nav__link">
<span class="md-ellipsis">
Environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../fileSystems/" class="md-nav__link">
<span class="md-ellipsis">
fileSystems
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../fonts/" class="md-nav__link">
<span class="md-ellipsis">
Fonts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../gtk/" class="md-nav__link">
<span class="md-ellipsis">
Gtk
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../hardware/" class="md-nav__link">
<span class="md-ellipsis">
Hardware
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../i18n/" class="md-nav__link">
<span class="md-ellipsis">
I18n
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../image/" class="md-nav__link">
<span class="md-ellipsis">
Image
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../lib/" class="md-nav__link">
<span class="md-ellipsis">
Lib
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../location/" class="md-nav__link">
<span class="md-ellipsis">
Location
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix/" class="md-nav__link">
<span class="md-ellipsis">
Nix
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nixops/" class="md-nav__link">
<span class="md-ellipsis">
Nixops
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nixpkgs/" class="md-nav__link">
<span class="md-ellipsis">
Nixpkgs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../oci/" class="md-nav__link">
<span class="md-ellipsis">
Oci
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../openstack/" class="md-nav__link">
<span class="md-ellipsis">
Openstack
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../power/" class="md-nav__link">
<span class="md-ellipsis">
Power
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../powerManagement/" class="md-nav__link">
<span class="md-ellipsis">
powerManagement
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../qt/" class="md-nav__link">
<span class="md-ellipsis">
Qt
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../specialisation/" class="md-nav__link">
<span class="md-ellipsis">
Specialisation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../swapDevices/" class="md-nav__link">
<span class="md-ellipsis">
swapDevices
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../system/" class="md-nav__link">
<span class="md-ellipsis">
System
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../time/" class="md-nav__link">
<span class="md-ellipsis">
Time
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../xdg/" class="md-nav__link">
<span class="md-ellipsis">
Xdg
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../zramSwap/" class="md-nav__link">
<span class="md-ellipsis">
zramSwap
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../boot/" class="md-nav__link">
<span class="md-ellipsis">
Boot
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../networking/" class="md-nav__link">
<span class="md-ellipsis">
Networking
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../programs/_1password-gui/" class="md-nav__link">
<span class="md-ellipsis">
Programs
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../security/" class="md-nav__link">
<span class="md-ellipsis">
Security
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../services/" class="md-nav__link">
<span class="md-ellipsis">
Services
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../systemd/" class="md-nav__link">
<span class="md-ellipsis">
Systemd
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../users/" class="md-nav__link">
<span class="md-ellipsis">
Users
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../virtualisation/" class="md-nav__link">
<span class="md-ellipsis">
Virtualisation
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Nixpkgs/" class="md-nav__link">
<span class="md-ellipsis">
Nixpkgs
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#documentationdevenable" class="md-nav__link">
<span class="md-ellipsis">
documentation.dev.enable
</span>
</a>
<nav class="md-nav" aria-label="documentation.dev.enable">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationdocenable" class="md-nav__link">
<span class="md-ellipsis">
documentation.doc.enable
</span>
</a>
<nav class="md-nav" aria-label="documentation.doc.enable">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_1" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationenable" class="md-nav__link">
<span class="md-ellipsis">
documentation.enable
</span>
</a>
<nav class="md-nav" aria-label="documentation.enable">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_2" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationinfoenable" class="md-nav__link">
<span class="md-ellipsis">
documentation.info.enable
</span>
</a>
<nav class="md-nav" aria-label="documentation.info.enable">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_3" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanenable" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.enable
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.enable">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_4" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmangeneratecaches" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.generateCaches
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.generateCaches">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_5" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanman-dbenable" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.man-db.enable
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.man-db.enable">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_6" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanman-dbmanualpages" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.man-db.manualPages
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.man-db.manualPages">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_7" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanman-dbpackage" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.man-db.package
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.man-db.package">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_8" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandoccachepath" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.cachePath
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.cachePath">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_9" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_1" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocenable" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.enable
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.enable">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_10" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_2" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocextraconfig" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.extraConfig
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.extraConfig">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_11" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocmanpath" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.manPath
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.manPath">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_12" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_3" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocpackage" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.package
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.package">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_13" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettings" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_14" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsmanpath" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.manpath
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.manpath">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_15" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_4" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsoutputfragment" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.output.fragment
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.output.fragment">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_16" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_5" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsoutputincludes" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.output.includes
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.output.includes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_17" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_6" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsoutputindent" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.output.indent
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.output.indent">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_18" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsoutputman" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.output.man
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.output.man">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_19" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_7" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsoutputpaper" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.output.paper
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.output.paper">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_20" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsoutputstyle" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.output.style
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.output.style">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_21" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsoutputtoc" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.output.toc
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.output.toc">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_22" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_8" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationmanmandocsettingsoutputwidth" class="md-nav__link">
<span class="md-ellipsis">
documentation.man.mandoc.settings.output.width
</span>
</a>
<nav class="md-nav" aria-label="documentation.man.mandoc.settings.output.width">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_23" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationnixosenable" class="md-nav__link">
<span class="md-ellipsis">
documentation.nixos.enable
</span>
</a>
<nav class="md-nav" aria-label="documentation.nixos.enable">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_24" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationnixosextramodulesources" class="md-nav__link">
<span class="md-ellipsis">
documentation.nixos.extraModuleSources
</span>
</a>
<nav class="md-nav" aria-label="documentation.nixos.extraModuleSources">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_25" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example_9" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationnixosextramodules" class="md-nav__link">
<span class="md-ellipsis">
documentation.nixos.extraModules
</span>
</a>
<nav class="md-nav" aria-label="documentation.nixos.extraModules">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_26" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationnixosincludeallmodules" class="md-nav__link">
<span class="md-ellipsis">
documentation.nixos.includeAllModules
</span>
</a>
<nav class="md-nav" aria-label="documentation.nixos.includeAllModules">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_27" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationnixosoptionssplitbuild" class="md-nav__link">
<span class="md-ellipsis">
documentation.nixos.options.splitBuild
</span>
</a>
<nav class="md-nav" aria-label="documentation.nixos.options.splitBuild">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_28" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentationnixosoptionswarningsareerrors" class="md-nav__link">
<span class="md-ellipsis">
documentation.nixos.options.warningsAreErrors
</span>
</a>
<nav class="md-nav" aria-label="documentation.nixos.options.warningsAreErrors">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#default_29" class="md-nav__link">
<span class="md-ellipsis">
Default
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1>Documentation</h1>
<p>Documentation</p>
<h2 documentation-dev-enable="documentation-dev-enable" id="documentationdevenable"><code>documentation.dev.enable</code></h2>
<p>Whether to install documentation targeted at developers.
* This includes man pages targeted at developers if {option}<code>documentation.man.enable</code> is
set (this also includes "devman" outputs).
* This includes info pages targeted at developers if {option}<code>documentation.info.enable</code>
is set (this also includes "devinfo" outputs).
* This includes other pages targeted at developers if {option}<code>documentation.doc.enable</code>
is set (this also includes "devdoc" outputs).</p>
<p><strong>Type:</strong> <code>boolean</code></p>
<h3 documentation-dev-enable-default="documentation-dev-enable-default" id="default">Default</h3>
<p><code class="highlight"><span class="no">false</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix</a></p>
<h2 documentation-doc-enable="documentation-doc-enable" id="documentationdocenable"><code>documentation.doc.enable</code></h2>
<p>Whether to install documentation distributed in packages' <code>/share/doc</code>.
Usually plain text and/or HTML.
This also includes "doc" outputs.</p>
<p><strong>Type:</strong> <code>boolean</code></p>
<h3 documentation-doc-enable-default="documentation-doc-enable-default" id="default_1">Default</h3>
<p><code class="highlight"><span class="no">true</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix</a></p>
<h2 documentation-enable="documentation-enable" id="documentationenable"><code>documentation.enable</code></h2>
<p>Whether to install documentation of packages from
{option}<code>environment.systemPackages</code> into the generated system path.</p>
<p>See "Multiple-output packages" chapter in the nixpkgs manual for more info.</p>
<p><strong>Type:</strong> <code>boolean</code></p>
<h3 documentation-enable-default="documentation-enable-default" id="default_2">Default</h3>
<p><code class="highlight"><span class="no">true</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix</a></p>
<h2 documentation-info-enable="documentation-info-enable" id="documentationinfoenable"><code>documentation.info.enable</code></h2>
<p>Whether to install info pages and the {command}<code>info</code> command.
This also includes "info" outputs.</p>
<p><strong>Type:</strong> <code>boolean</code></p>
<h3 documentation-info-enable-default="documentation-info-enable-default" id="default_3">Default</h3>
<p><code class="highlight"><span class="no">true</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix</a></p>
<h2 documentation-man-enable="documentation-man-enable" id="documentationmanenable"><code>documentation.man.enable</code></h2>
<p>Whether to install manual pages.
This also includes <code>man</code> outputs.</p>
<p><strong>Type:</strong> <code>boolean</code></p>
<h3 documentation-man-enable-default="documentation-man-enable-default" id="default_4">Default</h3>
<p><code class="highlight"><span class="no">true</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix</a></p>
<h2 documentation-man-generateCaches="documentation-man-generateCaches" id="documentationmangeneratecaches"><code>documentation.man.generateCaches</code></h2>
<p>Whether to generate the manual page index caches.
This allows searching for a page or
keyword using utilities like {manpage}<code>apropos(1)</code>
and the <code>-k</code> option of
{manpage}<code>man(1)</code>.</p>
<p><strong>Type:</strong> <code>boolean</code></p>
<h3 documentation-man-generateCaches-default="documentation-man-generateCaches-default" id="default_5">Default</h3>
<p><code class="highlight"><span class="no">false</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix</a></p>
<h2 documentation-man-man-db-enable="documentation-man-man-db-enable" id="documentationmanman-dbenable"><code>documentation.man.man-db.enable</code></h2>
<p>Whether to enable man-db as the default man page viewer.
<strong>Type:</strong> <code>boolean</code></p>
<h3 documentation-man-man-db-enable-default="documentation-man-man-db-enable-default" id="default_6">Default</h3>
<p><code class="highlight">config<span class="o">.</span>documentation<span class="o">.</span>man<span class="o">.</span>enable</code></p>
<h3 documentation-man-man-db-enable-example="documentation-man-man-db-enable-example" id="example">Example</h3>
<p><code class="highlight"><span class="no">false</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/man-db.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/man-db.nix</a></p>
<h2 documentation-man-man-db-manualPages="documentation-man-man-db-manualPages" id="documentationmanman-dbmanualpages"><code>documentation.man.man-db.manualPages</code></h2>
<p>The manual pages to generate caches for if {option}<code>documentation.man.generateCaches</code>
is enabled. Must be a path to a directory with man pages under
<code>/share/man</code>; see the source for an example.
Advanced users can make this a content-addressed derivation to save a few rebuilds.</p>
<p><strong>Type:</strong> <code>path</code></p>
<h3 documentation-man-man-db-manualPages-default="documentation-man-man-db-manualPages-default" id="default_7">Default</h3>
<p>all man pages in {option}<code>config.environment.systemPackages</code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/man-db.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/man-db.nix</a></p>
<h2 documentation-man-man-db-package="documentation-man-man-db-package" id="documentationmanman-dbpackage"><code>documentation.man.man-db.package</code></h2>
<p>The <code>man-db</code> derivation to use. Useful to override
configuration options used for the package.</p>
<p><strong>Type:</strong> <code>package</code></p>
<h3 documentation-man-man-db-package-default="documentation-man-man-db-package-default" id="default_8">Default</h3>
<p><code class="highlight">pkgs<span class="o">.</span>man-db</code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/man-db.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/man-db.nix</a></p>
<h2 documentation-man-mandoc-cachePath="documentation-man-mandoc-cachePath" id="documentationmanmandoccachepath"><code>documentation.man.mandoc.cachePath</code></h2>
<p>Change the paths where mandoc {manpage}<code>makewhatis(8)</code>generates the
manual page index caches. {option}<code>documentation.man.generateCaches</code>
should be enabled to allow cache generation. This list should only
include the paths to manpages installed in the system configuration,
i. e. /run/current-system/sw/share/man. {manpage}<code>makewhatis(8)</code>
creates a database in each directory using the files
<code>mansection/[arch/]title.section</code> and <code>catsection/[arch/]title.0</code>
in it. If a directory contains no manual pages, no database is
created in that directory.
This option only needs to be set manually if extra paths should be
indexed or {option}<code>documentation.man.manPath</code> contains paths that
can't be indexed.</p>
<p><strong>Type:</strong> <code>list of string</code></p>
<h3 documentation-man-mandoc-cachePath-default="documentation-man-mandoc-cachePath-default" id="default_9">Default</h3>
<p><code class="highlight">config<span class="o">.</span>documentation<span class="o">.</span>man<span class="o">.</span>mandoc<span class="o">.</span>manPath</code></p>
<h3 documentation-man-mandoc-cachePath-example="documentation-man-mandoc-cachePath-example" id="example_1">Example</h3>
<p><code class="highlight"><span class="p">[</span> <span class="s2">&quot;share/man&quot;</span> <span class="s2">&quot;share/man/fr&quot;</span> <span class="p">]</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix</a></p>
<h2 documentation-man-mandoc-enable="documentation-man-mandoc-enable" id="documentationmanmandocenable"><code>documentation.man.mandoc.enable</code></h2>
<p>Whether to enable mandoc as the default man page viewer.
<strong>Type:</strong> <code>boolean</code></p>
<h3 documentation-man-mandoc-enable-default="documentation-man-mandoc-enable-default" id="default_10">Default</h3>
<p><code class="highlight"><span class="no">false</span></code></p>
<h3 documentation-man-mandoc-enable-example="documentation-man-mandoc-enable-example" id="example_2">Example</h3>
<p><code class="highlight"><span class="no">true</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix</a></p>
<h2 documentation-man-mandoc-extraConfig="documentation-man-mandoc-extraConfig" id="documentationmanmandocextraconfig"><code>documentation.man.mandoc.extraConfig</code></h2>
<p>Extra configuration to write to {manpage}<code>man.conf(5)</code>.</p>
<p><strong>Type:</strong> <code>strings concatenated with "\n"</code></p>
<h3 documentation-man-mandoc-extraConfig-default="documentation-man-mandoc-extraConfig-default" id="default_11">Default</h3>
<p><code class="highlight"><span class="s2">&quot;&quot;</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix</a></p>
<h2 documentation-man-mandoc-manPath="documentation-man-mandoc-manPath" id="documentationmanmandocmanpath"><code>documentation.man.mandoc.manPath</code></h2>
<p>Change the paths included in the MANPATH environment variable,
i. e. the directories where {manpage}<code>man(1)</code>
looks for section-specific directories of man pages.
You only need to change this setting if you want extra man pages
(e. g. in non-english languages). All values must be strings that
are a valid path from the target prefix (without including it).
The first value given takes priority. Note that this will not
add manpath directives to {manpage}<code>man.conf(5)</code>.</p>
<p><strong>Type:</strong> <code>list of string</code></p>
<h3 documentation-man-mandoc-manPath-default="documentation-man-mandoc-manPath-default" id="default_12">Default</h3>
<p><code class="highlight"><span class="p">[</span><span class="s2">&quot;share/man&quot;</span><span class="p">]</span></code></p>
<h3 documentation-man-mandoc-manPath-example="documentation-man-mandoc-manPath-example" id="example_3">Example</h3>
<p><code class="highlight"><span class="p">[</span> <span class="s2">&quot;share/man&quot;</span> <span class="s2">&quot;share/man/fr&quot;</span> <span class="p">]</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix</a></p>
<h2 documentation-man-mandoc-package="documentation-man-mandoc-package" id="documentationmanmandocpackage"><code>documentation.man.mandoc.package</code></h2>
<p>The <code>mandoc</code> derivation to use. Useful to override
configuration options used for the package.</p>
<p><strong>Type:</strong> <code>package</code></p>
<h3 documentation-man-mandoc-package-default="documentation-man-mandoc-package-default" id="default_13">Default</h3>
<p><code class="highlight">pkgs<span class="o">.</span>mandoc</code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix</a></p>
<h2 documentation-man-mandoc-settings="documentation-man-mandoc-settings" id="documentationmanmandocsettings"><code>documentation.man.mandoc.settings</code></h2>
<p>Configuration for {manpage}<code>man.conf(5)</code>
<strong>Type:</strong> <code>submodule</code></p>
<h3 documentation-man-mandoc-settings-default="documentation-man-mandoc-settings-default" id="default_14">Default</h3>
<p><code class="highlight"><span class="p">{</span> <span class="p">}</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix</a></p>
<h2 documentation-man-mandoc-settings-manpath="documentation-man-mandoc-settings-manpath" id="documentationmanmandocsettingsmanpath"><code>documentation.man.mandoc.settings.manpath</code></h2>
<p>Override the default search path for {manpage}<code>man(1)</code>,
{manpage}<code>apropos(1)</code>, and {manpage}<code>makewhatis(8)</code>. It can be
used multiple times to specify multiple paths, with the order
determining the manual page search order.
This is not recommended in favor of
{option}<code>documentation.man.mandoc.manPath</code>, but if it's needed to
specify the manpath in this way, set
{option}<code>documentation.man.mandoc.manPath</code> to an empty list (<code>[]</code>).</p>
<p><strong>Type:</strong> <code>list of string</code></p>
<h3 documentation-man-mandoc-settings-manpath-default="documentation-man-mandoc-settings-manpath-default" id="default_15">Default</h3>
<p><code class="highlight"><span class="p">[</span> <span class="p">]</span></code></p>
<h3 documentation-man-mandoc-settings-manpath-example="documentation-man-mandoc-settings-manpath-example" id="example_4">Example</h3>
<p><code class="highlight"><span class="p">[</span> <span class="s2">&quot;/run/current-system/sw/share/man&quot;</span> <span class="p">]</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix</a></p>
<h2 documentation-man-mandoc-settings-output-fragment="documentation-man-mandoc-settings-output-fragment" id="documentationmanmandocsettingsoutputfragment"><code>documentation.man.mandoc.settings.output.fragment</code></h2>
<p>Whether to omit the &lt;!DOCTYPE&gt; declaration and the <html>, <head>, and <body>
elements and only emit the subtree below the <body> element in HTML
output of {manpage}<code>mandoc(1)</code>. The style argument will be ignored.
This is useful when embedding manual content within existing documents.</p>
<p><strong>Type:</strong> <code>boolean</code></p>
<h3 documentation-man-mandoc-settings-output-fragment-default="documentation-man-mandoc-settings-output-fragment-default" id="default_16">Default</h3>
<p><code class="highlight"><span class="no">false</span></code></p>
<h3 documentation-man-mandoc-settings-output-fragment-example="documentation-man-mandoc-settings-output-fragment-example" id="example_5">Example</h3>
<p><code class="highlight"><span class="no">true</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix</a></p>
<h2 documentation-man-mandoc-settings-output-includes="documentation-man-mandoc-settings-output-includes" id="documentationmanmandocsettingsoutputincludes"><code>documentation.man.mandoc.settings.output.includes</code></h2>
<p>A string of relative path used as a template for the output path of
linked header files (usually via the In macro) in HTML output.
Instances of <code>%I</code> are replaced with the include filename. The
default is not to present a hyperlink.</p>
<p><strong>Type:</strong> <code>null or string</code></p>
<h3 documentation-man-mandoc-settings-output-includes-default="documentation-man-mandoc-settings-output-includes-default" id="default_17">Default</h3>
<p><code class="highlight"><span class="no">null</span></code></p>
<h3 documentation-man-mandoc-settings-output-includes-example="documentation-man-mandoc-settings-output-includes-example" id="example_6">Example</h3>
<p><code class="highlight"><span class="l">../src</span><span class="o">/</span><span class="err">%</span>I<span class="o">.</span>html</code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix</a></p>
<h2 documentation-man-mandoc-settings-output-indent="documentation-man-mandoc-settings-output-indent" id="documentationmanmandocsettingsoutputindent"><code>documentation.man.mandoc.settings.output.indent</code></h2>
<p>Number of blank characters at the left margin for normal text,
default of <code>5</code> for {manpage}<code>mdoc(7)</code> and <code>7</code> for
{manpage}<code>man(7)</code>. Increasing this is not recommended; it may
result in degraded formatting, for example overfull lines or ugly
line breaks. When output is to a pager on a terminal that is less
than 66 columns wide, the default is reduced to three columns.</p>
<p><strong>Type:</strong> <code>null or signed integer</code></p>
<h3 documentation-man-mandoc-settings-output-indent-default="documentation-man-mandoc-settings-output-indent-default" id="default_18">Default</h3>
<p><code class="highlight"><span class="no">null</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix</a></p>
<h2 documentation-man-mandoc-settings-output-man="documentation-man-mandoc-settings-output-man" id="documentationmanmandocsettingsoutputman"><code>documentation.man.mandoc.settings.output.man</code></h2>
<p>A template for linked manuals (usually via the Xr macro) in HTML
output. Instances of ‘%N’ and ‘%S’ are replaced with the linked
manual's name and section, respectively. If no section is included,
section 1 is assumed. The default is not to present a hyperlink.
If two formats are given and a file %N.%S exists in the current
directory, the first format is used; otherwise, the second format is used.</p>
<p><strong>Type:</strong> <code>null or string</code></p>
<h3 documentation-man-mandoc-settings-output-man-default="documentation-man-mandoc-settings-output-man-default" id="default_19">Default</h3>
<p><code class="highlight"><span class="no">null</span></code></p>
<h3 documentation-man-mandoc-settings-output-man-example="documentation-man-mandoc-settings-output-man-example" id="example_7">Example</h3>
<p><code class="highlight"><span class="l">../html</span><span class="err">%</span>S<span class="o">/</span><span class="err">%</span>N<span class="o">.</span><span class="err">%</span>S<span class="o">.</span>html</code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix</a></p>
<h2 documentation-man-mandoc-settings-output-paper="documentation-man-mandoc-settings-output-paper" id="documentationmanmandocsettingsoutputpaper"><code>documentation.man.mandoc.settings.output.paper</code></h2>
<p>This option is for generating PostScript and PDF output. The paper
size name may be one of <code>a3</code>, <code>a4</code>, <code>a5</code>, <code>legal</code>, or <code>letter</code>.
You may also manually specify dimensions as <code>NNxNN</code>, width by
height in millimetres. If an unknown value is encountered, letter
is used. Output pages default to letter sized and are rendered in
the Times font family, 11-point. Margins are calculated as 1/9 the
page length and width. Line-height is 1.4m.</p>
<p><strong>Type:</strong> <code>null or string</code></p>
<h3 documentation-man-mandoc-settings-output-paper-default="documentation-man-mandoc-settings-output-paper-default" id="default_20">Default</h3>
<p><code class="highlight"><span class="no">null</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix</a></p>
<h2 documentation-man-mandoc-settings-output-style="documentation-man-mandoc-settings-output-style" id="documentationmanmandocsettingsoutputstyle"><code>documentation.man.mandoc.settings.output.style</code></h2>
<p>Path to the file used for an external style-sheet. This must be a
valid absolute or relative URI.</p>
<p><strong>Type:</strong> <code>null or path</code></p>
<h3 documentation-man-mandoc-settings-output-style-default="documentation-man-mandoc-settings-output-style-default" id="default_21">Default</h3>
<p><code class="highlight"><span class="no">null</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix</a></p>
<h2 documentation-man-mandoc-settings-output-toc="documentation-man-mandoc-settings-output-toc" id="documentationmanmandocsettingsoutputtoc"><code>documentation.man.mandoc.settings.output.toc</code></h2>
<p>Whether to enable printing a table of contents near the beginning of the HTML output
of {manpage}<code>mandoc(1)</code> if an input file contains at least two
non-standard sections
.
<strong>Type:</strong> <code>boolean</code></p>
<h3 documentation-man-mandoc-settings-output-toc-default="documentation-man-mandoc-settings-output-toc-default" id="default_22">Default</h3>
<p><code class="highlight"><span class="no">false</span></code></p>
<h3 documentation-man-mandoc-settings-output-toc-example="documentation-man-mandoc-settings-output-toc-example" id="example_8">Example</h3>
<p><code class="highlight"><span class="no">true</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix</a></p>
<h2 documentation-man-mandoc-settings-output-width="documentation-man-mandoc-settings-output-width" id="documentationmanmandocsettingsoutputwidth"><code>documentation.man.mandoc.settings.output.width</code></h2>
<p>The ASCII and UTF-8 output width, default is <code>78</code>. When output is a
pager on a terminal that is less than 79 columns wide, the
default is reduced to one less than the terminal width. In any case,
lines that are output in literal mode are never wrapped and may
exceed the output width.</p>
<p><strong>Type:</strong> <code>null or signed integer</code></p>
<h3 documentation-man-mandoc-settings-output-width-default="documentation-man-mandoc-settings-output-width-default" id="default_23">Default</h3>
<p><code class="highlight"><span class="no">null</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/mandoc.nix</a></p>
<h2 documentation-nixos-enable="documentation-nixos-enable" id="documentationnixosenable"><code>documentation.nixos.enable</code></h2>
<p>Whether to install NixOS's own documentation.</p>
<ul>
<li>This includes man pages like
{manpage}<code>configuration.nix(5)</code> if {option}<code>documentation.man.enable</code> is
set.</li>
<li>This includes the HTML manual and the {command}<code>nixos-help</code> command if
{option}<code>documentation.doc.enable</code> is set.</li>
</ul>
<p><strong>Type:</strong> <code>boolean</code></p>
<h3 documentation-nixos-enable-default="documentation-nixos-enable-default" id="default_24">Default</h3>
<p><code class="highlight"><span class="no">true</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix</a></p>
<h2 documentation-nixos-extraModuleSources="documentation-nixos-extraModuleSources" id="documentationnixosextramodulesources"><code>documentation.nixos.extraModuleSources</code></h2>
<p>Which extra NixOS module paths the generated NixOS's documentation should strip
from options.</p>
<p><strong>Type:</strong> <code>list of (path or string)</code></p>
<h3 documentation-nixos-extraModuleSources-default="documentation-nixos-extraModuleSources-default" id="default_25">Default</h3>
<p><code class="highlight"><span class="p">[</span> <span class="p">]</span></code></p>
<h3 documentation-nixos-extraModuleSources-example="documentation-nixos-extraModuleSources-example" id="example_9">Example</h3>
<p><code class="highlight"><span class="c1"># e.g. with options from modules in ${pkgs.customModules}/nix:</span><span class="p">[</span> pkgs<span class="o">.</span>customModules <span class="p">]</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix</a></p>
<h2 documentation-nixos-extraModules="documentation-nixos-extraModules" id="documentationnixosextramodules"><code>documentation.nixos.extraModules</code></h2>
<p>Modules for which to show options even when not imported.</p>
<p><strong>Type:</strong> <code>list of raw value</code></p>
<h3 documentation-nixos-extraModules-default="documentation-nixos-extraModules-default" id="default_26">Default</h3>
<p><code class="highlight"><span class="p">[</span> <span class="p">]</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix</a></p>
<h2 documentation-nixos-includeAllModules="documentation-nixos-includeAllModules" id="documentationnixosincludeallmodules"><code>documentation.nixos.includeAllModules</code></h2>
<p>Whether the generated NixOS's documentation should include documentation for all
the options from all the NixOS modules included in the current
<code>configuration.nix</code>. Disabling this will make the manual
generator to ignore options defined outside of <code>baseModules</code>.</p>
<p><strong>Type:</strong> <code>boolean</code></p>
<h3 documentation-nixos-includeAllModules-default="documentation-nixos-includeAllModules-default" id="default_27">Default</h3>
<p><code class="highlight"><span class="no">false</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix</a></p>
<h2 documentation-nixos-options-splitBuild="documentation-nixos-options-splitBuild" id="documentationnixosoptionssplitbuild"><code>documentation.nixos.options.splitBuild</code></h2>
<p>Whether to split the option docs build into a cacheable and an uncacheable part.
Splitting the build can substantially decrease the amount of time needed to build
the manual, but some user modules may be incompatible with this splitting.</p>
<p><strong>Type:</strong> <code>boolean</code></p>
<h3 documentation-nixos-options-splitBuild-default="documentation-nixos-options-splitBuild-default" id="default_28">Default</h3>
<p><code class="highlight"><span class="no">true</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix</a></p>
<h2 documentation-nixos-options-warningsAreErrors="documentation-nixos-options-warningsAreErrors" id="documentationnixosoptionswarningsareerrors"><code>documentation.nixos.options.warningsAreErrors</code></h2>
<p>Treat warning emitted during the option documentation build (eg for missing option
descriptions) as errors.</p>
<p><strong>Type:</strong> <code>boolean</code></p>
<h3 documentation-nixos-options-warningsAreErrors-default="documentation-nixos-options-warningsAreErrors-default" id="default_29">Default</h3>
<p><code class="highlight"><span class="no">true</span></code></p>
<p><strong>Declared by:</strong> <a href="https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix">https://github.com/nixos/nixpkgs/blob/master/nixos/modules/misc/documentation.nix</a></p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
Licenced MIT
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-social">
<a href="https://git.auxolotl.org/auxolotl/docs" target="_blank" rel="noopener" title="Aux Docs Repo" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.777 0a2.9 2.9 0 1 1-2.529 4.322H12.91a4.266 4.266 0 0 0-4.265 4.195v2.118a7.076 7.076 0 0 1 4.147-1.42l.118-.002h1.338a2.9 2.9 0 0 1 5.43 1.422 2.9 2.9 0 0 1-5.43 1.422H12.91a4.266 4.266 0 0 0-4.265 4.195v2.319A2.9 2.9 0 0 1 7.222 24 2.9 2.9 0 0 1 5.8 18.57V8.589a7.109 7.109 0 0 1 6.991-7.108l.118-.001h1.338A2.9 2.9 0 0 1 16.778 0ZM7.223 19.905a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Zm9.554-10.464a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.39Zm0-7.735a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Z"/></svg>
</a>
<a href="https://forum.aux.computer/" target="_blank" rel="noopener" title="Aux Forum" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12.103 0C18.666 0 24 5.485 24 11.997c0 6.51-5.33 11.99-11.9 11.99L0 24V11.79C0 5.28 5.532 0 12.103 0zm.116 4.563a7.395 7.395 0 0 0-6.337 3.57 7.247 7.247 0 0 0-.148 7.22L4.4 19.61l4.794-1.074a7.424 7.424 0 0 0 8.136-1.39 7.256 7.256 0 0 0 1.737-7.997 7.375 7.375 0 0 0-6.84-4.585h-.008z"/></svg>
</a>
<a href="https://wiki.auxolotl.org/" target="_blank" rel="noopener" title="Aux Wiki" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17.801 13.557c.148.098.288.202.417.313 1.854 1.6 3.127 4.656 2.582 7.311-1.091-.255-5.747-1.055-7.638-3.383-.91-1.12-1.366-2.081-1.569-2.885a5.65 5.65 0 0 0 .034-.219c.089.198.197.35.313.466.24.24.521.335.766.372.304.046.594-.006.806-.068l.001.001c.05-.015.433-.116.86-.342.325-.173 2.008-.931 3.428-1.566Zm-7.384 1.435C9.156 16.597 6.6 18.939.614 18.417c.219-1.492 1.31-3.019 2.51-4.11.379-.345.906-.692 1.506-1.009.286.168.598.332.939.486 2.689 1.221 3.903 1.001 4.89.573a1.3 1.3 0 0 0 .054-.025 6.156 6.156 0 0 0-.096.66Zm4.152-.462c.38-.341.877-.916 1.383-1.559-.389-.15-.866-.371-1.319-.591-.598-.29-1.305-.283-2.073-.315a4.685 4.685 0 0 1-.804-.103c.014-.123.027-.246.038-.369.062.104.673.057.871.057.354 0 1.621.034 3.074-.574 1.452-.608 2.55-1.706 3.022-3.225.474-1.52.22-3.091-.168-3.952-.169.709-1.453 2.381-1.926 2.871-.473.489-2.381 2.296-2.972 2.921-.7.74-.688.793-1.332 1.302-.202.19-.499.402-.563.53.027-.338.039-.675.027-.997a7.653 7.653 0 0 0-.032-.523c.322-.059.567-.522.567-.861 0-.224-.106-.247-.271-.229.075-.894.382-3.923 1.254-4.281.218.109.831.068.649-.295-.182-.364-.825-.074-1.081.266-.28.374-.956 2.046-.92 4.324-.113.014-.174.033-.322.033-.171 0-.321-.04-.433-.05.034-2.275-.714-3.772-.84-4.169-.12-.375-.491-.596-.781-.596-.146 0-.272.056-.333.179-.182.363.459.417.677.308.706.321 1.156 3.519 1.254 4.277-.125-.006-.199.035-.199.233 0 .311.17.756.452.843a.442.442 0 0 0-.007.03s-.287.99-.413 2.189a4.665 4.665 0 0 1-.718-.225c-.714-.286-1.355-.583-2.019-.566-.664.018-1.366.023-1.804-.036-.438-.058-.649-.15-.649-.15s-.234.365.257 1.075c.42.607 1.055 1.047 1.644 1.18.589.134 1.972.18 2.785-.377.16-.109.317-.228.459-.34a8.717 8.717 0 0 0-.013.626c-.289.753-.571 1.993-.268 3.338 0-.001.701-.842.787-2.958.006-.144.009-.271.01-.383.052-.248.103-.518.148-.799.072.135.151.277.234.413.511.842 1.791 1.37 2.383 1.49.091.019.187.032.285.038Zm-1.12.745c-.188.055-.445.1-.713.059-.21-.031-.45-.11-.655-.316-.169-.168-.312-.419-.401-.789a9.837 9.837 0 0 0 .039-.82l.049-.243c.563.855 1.865 1.398 2.476 1.522.036.008.072.014.109.02l-.013.009c-.579.415-.76.503-.891.558Zm6.333-2.818c-.257.114-4.111 1.822-5.246 2.363.98-.775 3.017-3.59 3.699-4.774 1.062.661 1.468 1.109 1.623 1.441.101.217.09.38.096.515a.57.57 0 0 1-.172.455Zm-9.213 1.62a1.606 1.606 0 0 1-.19.096c-.954.414-2.126.61-4.728-.571-2.023-.918-3.024-2.157-3.371-2.666.476.161 1.471.473 2.157.524.282.021.703.068 1.167.125.021.209.109.486.345.829l.001.001c.451.651 1.134 1.119 1.765 1.262.622.141 2.083.182 2.942-.407a3.12 3.12 0 0 0 .132-.093l.001.179a6.052 6.052 0 0 0-.221.721Zm5.512-1.271a17.49 17.49 0 0 1-1.326-.589c.437.042 1.054.083 1.692.108-.121.162-.244.323-.366.481Zm.932-1.26c-.12.17-.245.343-.373.517-.241.018-.478.03-.709.038a29.05 29.05 0 0 1-.741-.048c.608-.065 1.228-.252 1.823-.507Zm.22-.315c-.809.382-1.679.648-2.507.648-.472 0-.833.018-1.139.039v.001c-.324-.031-.665-.039-1.019-.054a3.555 3.555 0 0 1-.152-.009c.102-.002.192-.006.249-.006.363 0 1.662.034 3.151-.589 1.508-.632 2.645-1.773 3.136-3.351.37-1.186.31-2.402.086-3.312.458-.336.86-.651 1.147-.91.501-.451.743-.733.848-.869.199.206.714.864.685 2.138-.036 1.611-.606 3.187-1.501 4.154a9.099 9.099 0 0 1-1.321 1.132 11.978 11.978 0 0 0-.644-.422l-.089-.055-.051.091c-.184.332-.5.825-.879 1.374ZM4.763 5.817c-.157 1.144.113 2.323.652 3.099.539.776 2.088 2.29 3.614 2.505.991.14 2.055.134 2.055.134s-.593-.576-1.114-1.66c-.521-1.085-.948-2.104-1.734-2.786-.785-.681-1.601-1.416-2.045-1.945-.444-.53-.59-.86-.59-.86s-.656.175-.838 1.513Zm14.301 4.549a9.162 9.162 0 0 0 1.3-1.12c.326-.352.611-.782.845-1.265 1.315.145 2.399.371 2.791.434 0 0-.679 1.971-3.945 3.022l-.016-.035c-.121-.26-.385-.594-.975-1.036Zm-11.634.859a8.537 8.537 0 0 1-.598-.224c-1.657-.693-2.91-1.944-3.449-3.678-.498-1.601-.292-3.251.091-4.269.225.544.758 1.34 1.262 2.01a3.58 3.58 0 0 0-.172.726c-.163 1.197.123 2.428.687 3.24.416.599 1.417 1.62 2.555 2.193-.128.002-.253.003-.376.002Zm-1.758-.077c-.958-.341-1.901-.787-2.697-1.368C-.07 7.559 0 6.827 0 6.827s1.558-.005 3.088.179c.03.126.065.251.104.377.557 1.791 1.851 3.086 3.562 3.803l.047.019a4.254 4.254 0 0 1-.267-.026h-.001c-.401-.053-.595-.135-.595-.135l-.157-.069-.092.144-.017.029Zm6.807-1.59c.086.017.136.058.136.145 0 .197-.242.5-.597.597l-.01-.161a.887.887 0 0 0 .283-.243c.078-.099.142-.217.188-.338Zm-1.591.006c.033.1.076.197.129.282.061.097.134.18.217.24l-.021.083c-.276-.093-.424-.293-.424-.466 0-.078.035-.119.099-.139Zm-.025-.664c-.275-.816-.795-2.022-1.505-2.179-.296.072-.938.096-.691-.145.246-.24 1.085-.048 1.283.217.145.194.744.806 1.011 1.737l.032.227a.324.324 0 0 0-.13.143Zm1.454-.266c.251-.99.889-1.639 1.039-1.841.197-.265 1.036-.457 1.283-.217.247.241-.395.217-.691.145-.69.152-1.2 1.296-1.481 2.109a.364.364 0 0 0-.067-.059.37.37 0 0 0-.092-.043l.009-.094Zm4.802-2.708a9.875 9.875 0 0 1-.596.705c-.304.315-1.203 1.176-1.963 1.916.647-.955 1.303-1.806 2.184-2.376.123-.08.249-.161.375-.245Z"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": ["content.tooltips", "search.highlight", "navigation.tabs", "navigation.indexes", "navigation.prune"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../../assets/javascripts/bundle.fe8b6f2b.min.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink