1Config::Generator::FileU(s3e)r Contributed Perl DocumentaCtoinofnig::Generator::File(3)
2
3
4

NAME

6       Config::Generator::File - Config::Generator file support
7

DESCRIPTION

9       This module eases the manipulation of files, directories and symbolic
10       links.
11
12       The goal is to perform all the file related operations through this
13       module so that there is a consistent handling of the Config::Generator
14       variables: $NoAction, $RootDir and $Verbosity.
15
16       In addition, rpm compatible spec files snippets can be generated and
17       the yacg command can use a "manifest" file to record which files it did
18       create. This is required in order to be able to "clean out the junk",
19       see yacg's --clean option.
20

FUNCTIONS

22       This module provides the following functions (none of them being
23       exported by default):
24
25       ensure_directory(PATH)
26           make sure the given PATH is a directory
27
28       ensure_file(PATH, CONTENTS)
29           make sure the given PATH is a file with the given CONTENTS
30
31       ensure_symlink(PATH, TARGET)
32           make sure the given PATH is a symbolic link with the given TARGET
33
34       ensure_mode(PATH, MODE)
35           make sure the given PATH has the given numerical MODE
36
37       ensure_user(PATH, USER)
38           make sure the given PATH is owned by the given USER
39
40       ensure_group(PATH, GROUP)
41           make sure the given PATH is owned by the given GROUP
42
43       files_manifest()
44           return the list of all the files that have been manipulated by this
45           module
46
47       files_spec()
48           return the list of all the files that have been manipulated by this
49           module, in a format compatible with rpm's spec %files
50
51       handle_manifest(PATH, CLEAN)
52           write the list of all the files that have been manipulated by this
53           module in a "manifest" file at the given PATH; if CLEAN is true,
54           also remove all the files and directories that were in the previous
55           manifest and are not present anymore
56
57       handle_spec(PATH)
58           write the list of all the files that have been manipulated by this
59           module in a "spec" file at the given PATH
60

AUTHOR

62       Lionel Cons <http://cern.ch/lionel.cons>
63
64       Copyright (C) CERN 2013-2016
65
66
67
68perl v5.36.0                      2023-01-20        Config::Generator::File(3)
Impressum