chn/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2026-01-12 01:50:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

treewide: convert all option docs to Markdown

Browse Source 
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

To reproduce this commit, run:

  $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
    nix shell nixpkgs#coreutils \
    -c find . -name '*.nix' \
    -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
This commit is contained in:
Emily
2023-07-01 00:30:13 +01:00
parent c1d8d2a3d1
commit 36a53d9f26
355 changed files with 3805 additions and 3886 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
modules/programs/tmate.nix
View File

@@ -11,28 +11,28 @@ in {
options = {
programs.tmate = {
enable = mkEnableOption "tmate";
enable = mkEnableOption (lib.mdDoc "tmate");
package = mkOption {
type = types.package;
default = pkgs.tmate;
defaultText = literalExpression "pkgs.tmate";
example = literalExpression "pkgs.tmate";
description = "The tmate package to install.";
description = lib.mdDoc "The tmate package to install.";
};
host = mkOption {
type = with types; nullOr str;
default = null;
example = literalExpression "tmate.io";
description = "Tmate server address.";
description = lib.mdDoc "Tmate server address.";
};
port = mkOption {
type = with types; nullOr port;
default = null;
example = 2222;
description = "Tmate server port.";
description = lib.mdDoc "Tmate server port.";
};
dsaFingerprint = mkOption {
@@ -40,7 +40,7 @@ in {
default = null;
example = literalExpression
"SHA256:1111111111111111111111111111111111111111111";
description = "Tmate server EdDSA key fingerprint.";
description = lib.mdDoc "Tmate server EdDSA key fingerprint.";
};
rsaFingerprint = mkOption {
@@ -48,15 +48,15 @@ in {
default = null;
example = literalExpression
"SHA256:1111111111111111111111111111111111111111111";
description = "Tmate server RSA key fingerprint.";
description = lib.mdDoc "Tmate server RSA key fingerprint.";
};
extraConfig = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Additional content written at the end of
<filename>~/.tmate.conf</filename>.
{file}`~/.tmate.conf`.
'';
};
};