Debian Codegraph @

docs/src/man1/cdist-new-type.rst

raw
1 cdist-new-type(1)
2 =================
3
4 NAME
5 ----
6 cdist-new-type - Create new type skeleton
7
8
9 SYNOPSIS
10 --------
11
12 ::
13
14 cdist-new-type TYPE-NAME AUTHOR-NAME AUTHOR-EMAIL [TYPE-BASE-PATH]
15
16
17
18 DESCRIPTION
19 -----------
20 cdist-new-type is a helper script that creates new type skeleton.
21 It is then up to the type author to finish the type.
22
23 It creates skeletons for the following files:
24
25 * man.rst
26 * manifest
27 * gencode-remote.
28
29 Upon creation it prints the path to the newly created type directory.
30
31
32 ARGUMENTS
33 ---------
34 **TYPE-NAME**
35 Name of the new type.
36
37 **AUTHOR-NAME**
38 Type author's full name.
39
40 **AUTHOR-NAME**
41 Type author's email.
42
43 **TYPE-BASE-PATH**
44 Path to the base directory of the type. If not set it defaults
45 to '$PWD/type'.
46
47
48 EXAMPLES
49 --------
50
51 .. code-block:: sh
52
53 # Create new type __foo in ~/.cdist directory.
54 $ cd ~/.cdist
55 $ cdist-new-type '__foo' 'Foo Bar' 'foo.bar at foobar.org'
56 /home/foo/.cdist/type/__foo
57
58
59 SEE ALSO
60 --------
61 :strong:`cdist`\ (1)
62
63
64 AUTHORS
65 -------
66
67 | Steven Armstrong <[email protected]>
68 | Darko Poljak <[email protected]>
69
70
71 COPYING
72 -------
73 Copyright \(C) 2019 Steven Armstrong, Darko Poljak. Free use of this software is
74 granted under the terms of the GNU General Public License v3 or later (GPLv3+).