blob: bea6b255150b69aa2eb7008f45b328f31bc167cb (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
{ outputAttrPath, optionsAttrPath, optionsInternal ? true, }:
{ config, lib, pkgs, ... }:
with lib;
let
cfg = getAttrFromPath (optionsAttrPath ++ [ "manpage" ]) config;
in
{
options = setAttrByPath optionsAttrPath {
manpage = {
name = mkOption {
type = types.str;
description = ''
Name of the generated manpage.
'';
internal = optionsInternal;
};
shortDescription = mkOption {
type = types.str;
description = ''
A short description of the generated manpage.
'';
internal = optionsInternal;
};
description = mkOption {
type = with types; nullOr lines;
description = ''
A long description of the generated manpage.
'';
default = null;
internal = optionsInternal;
};
section = mkOption {
type = types.int;
default = 5;
description = ''
The section number for the generated manpage.
The table below shows the section numbers of the manual followed by the types of pages they contain.
1. Executable programs or shell commands
2. System calls (functions provided by the kernel)
3. Library calls (functions within program libraries)
4. Special files (usually found in /dev)
5. File formats and conventions, e.g. /etc/passwd
6. Games
7. Miscellaneous (including macro packages and conventions), e.g. man(7), groff(7)
8. System administration commands (usually only for root)
9. Kernel routines [Non standard]
'';
internal = optionsInternal;
};
file = mkOption {
type = types.str;
description = ''
The file containing the generated manpage.
'';
default = "${strings.sanitizeDerivationName cfg.name}.${toString cfg.section}";
defaultText = "\${lib.strings.sanitizeDerivationName cfg.name}.\${toString cfg.section}";
internal = optionsInternal;
};
title = mkOption {
type = types.str;
default = "${toUpper (strings.sanitizeDerivationName cfg.name)}(${toString cfg.section})";
defaultText = "\${toUpper cfg.name}(\${toString cfg.section})";
description = ''
Title of the generated manpage.
'';
internal = optionsInternal;
};
textBefore = mkOption {
type = types.lines;
description = ''
Some text to insert before the list of options.
'';
default = "";
internal = optionsInternal;
};
textAfter = mkOption {
type = types.lines;
description = ''
Some text to insert after the list of options.
'';
default = "";
internal = optionsInternal;
};
};
};
config = setAttrByPath outputAttrPath {
manpage = pkgs.runCommand cfg.file
{
src = pkgs.writeText "${cfg.file}.md" ''
% ${cfg.title}
# NAME
${cfg.name} - ${cfg.shortDescription}
${optionalString (cfg.description != null) ''
# DESCRIPTION
${cfg.description}
''}
${cfg.textBefore}
# OPTIONS
You can use the following options:
${readFile (getAttrFromPath (outputAttrPath ++ ["doc-options-md"]) config)}
${cfg.textAfter}
'';
nativeBuildInputs = [ pkgs.pandoc ];
} ''
pandoc "$src" --from=markdown --to=man --standalone --output="$out"
'';
};
}
|
