1CDIST-TYPE__DOT_FILE(7)              cdist             CDIST-TYPE__DOT_FILE(7)
2
3
4

NAME

6       cdist-type__dot_file - install file under user's home directory
7

DESCRIPTION

9       This  type  installs a file (=__object_id) under user's home directory,
10       providing a way to install per-user configuration files. File owner and
11       group is deduced from user, for who file is installed.
12
13       Unlike regular __file type, you do not need make any assumptions, where
14       user's home directory is.
15

REQUIRED PARAMETERS

17       user   User, for who file is installed
18

OPTIONAL PARAMETERS

20       dirmode
21              forwarded to __directory type as mode
22
23       mode   forwarded to __file type
24
25       state  forwarded to __file type
26
27       source forwarded to __file type
28

MESSAGES

30       This type inherits all messages from file type, and do not add any new.
31

EXAMPLES

33          # Install .forward file for user 'alice'. Since state is 'present',
34          # user is not meant to edit this file, all changes will be overridden.
35          # It is good idea to put warning about it in file itself.
36          __dot_file .forward --user alice --source "$__files/forward"
37
38          # Install .muttrc for user 'bob', if not already present. User can safely
39          # edit it, his changes will not be overwritten.
40          __dot_file .muttrc --user bob --source "$__files/recommended_mutt_config" --state exists
41
42
43          # Install default xmonad config for user 'eve'. Parent directory is created automatically.
44          __dot_file .xmonad/xmonad.hs --user eve --state exists --source "$__files/xmonad.hs"
45

SEE ALSO

47       cdist-type__file(7)
48

COPYING

50       Copyright (C) 2015 Dmitry Bogatov. Free use of this software is granted
51       under  the  terms  of the GNU General Public License version 3 or later
52       (GPLv3+).
53

55       ungleich GmbH 2020
56
57
58
59
606.9.6                            Apr 20, 2021          CDIST-TYPE__DOT_FILE(7)
Impressum