{"id":7361,"date":"2022-12-20T19:37:49","date_gmt":"2022-12-20T22:37:49","guid":{"rendered":"http:\/\/lode.uno\/linux-man\/index.php\/2022\/12\/20\/mdkcommonfile-man3\/"},"modified":"2022-12-20T19:37:49","modified_gmt":"2022-12-20T22:37:49","slug":"mdkcommonfile-man3","status":"publish","type":"post","link":"https:\/\/lode.uno\/linux-man\/2022\/12\/20\/mdkcommonfile-man3\/","title":{"rendered":"MDK::Common::File (man3)"},"content":{"rendered":"

MDK::Common::File<\/h1>\n

NAME<\/a>
SYNOPSIS<\/a>
EXPORTS<\/a>
SEE ALSO<\/a> <\/p>\n

\n

NAME <\/a> <\/h2>\n

MDK::Common::File \u2212 miscellaneous file\/filename manipulation functions<\/p>\n

SYNOPSIS <\/a> <\/h2>\n

use MDK::Common::File qw(:all);<\/p>\n

EXPORTS <\/a> <\/h2>\n

dirname( FILENAME<\/small> )
basename( FILENAME<\/small> )<\/p>\n

returns the dirname\/basename of the file name<\/p>\n

cat_( FILES<\/small> )<\/p>\n

returns the files contents: in scalar context it returns a single string, in array context it returns the lines.<\/p>\n

If no file is found, undef is returned<\/p>\n

cat_or_die( FILENAME<\/small> )<\/p>\n

same as “cat_” but dies when something goes wrong<\/p>\n

cat_utf8( FILES<\/small> )<\/p>\n

same as C() but reads utf8 encoded strings<\/p>\n

cat_utf8_or_die( FILES<\/small> )<\/p>\n

same as C() but reads utf8 encoded strings<\/p>\n

cat__( FILEHANDLE REF<\/small> )<\/p>\n

returns the file content: in scalar context it returns a single string, in array context it returns the lines<\/p>\n

output( FILENAME, LIST<\/small> )<\/p>\n

creates a file and outputs the list (if the file exists, it is clobbered)<\/p>\n

output_utf8( FILENAME, LIST<\/small> )<\/p>\n

same as C() but writes utf8 encoded strings<\/p>\n

secured_output( FILENAME, LIST<\/small> )<\/p>\n

likes output()<\/b> but prevents insecured usage (it dies if somebody try to exploit the race window between unlink()<\/b> and creat()<\/b>)<\/p>\n

append_to_file( FILENAME, LIST<\/small> )<\/p>\n

add the LIST<\/small> at the end of the file<\/p>\n

output_p( FILENAME, LIST<\/small> )<\/p>\n

just like “output” but creates directories if needed<\/p>\n

output_with_perm( FILENAME, PERMISSION, LIST<\/small> )<\/p>\n

same as “output_p” but sets FILENAME<\/small> permission to PERMISSION<\/small> (using chmod)<\/p>\n

mkdir_p( DIRNAME<\/small> )<\/p>\n

creates the directory (make parent directories as needed)<\/p>\n

rm_rf( FILES<\/small> )<\/p>\n

remove the files (including sub-directories)<\/p>\n

cp_f( FILES, DEST<\/small> )<\/p>\n

just like “cp \u2212f”<\/p>\n

cp_af( FILES, DEST<\/small> )<\/p>\n

just like “cp \u2212af”<\/p>\n

cp_afx( FILES, DEST<\/small> )<\/p>\n

just like “cp \u2212afx”<\/p>\n

linkf( SOURCE, DESTINATION<\/small> )
symlinkf( SOURCE, DESTINATION<\/small> )
renamef( SOURCE, DESTINATION<\/small> )<\/p>\n

same as link\/symlink\/rename but removes the destination file first<\/p>\n

touch( FILENAME<\/small> )<\/p>\n

ensure the file exists, set the modification time to current time<\/p>\n

all( DIRNAME<\/small> )<\/p>\n

returns all the file in directory (except “.” and “..”)<\/p>\n

all_files_rec( DIRNAME<\/small> )<\/p>\n

returns all the files in directory and the sub-directories (except “.” and “..”)<\/p>\n

glob_( STRING<\/small> )<\/p>\n

simple version of “glob”: doesn\u2019t handle wildcards in directory (eg: *\/foo.c), nor special constructs (eg: [0\u22129] or {a,b})<\/p>\n

substInFile { CODE<\/small> } FILENAME<\/small><\/p>\n

executes the code for each line of the file. You can know the end of the file is reached using “eof”<\/p>\n

expand_symlinks( FILENAME<\/small> )<\/p>\n

expand the symlinks in the absolute filename: “expand_symlinks(“\/etc\/X11\/X”)” gives “\/usr\/bin\/Xorg”<\/p>\n

openFileMaybeCompressed( FILENAME<\/small> )<\/p>\n

opens the file and returns the file handle. If the file is not found, tries to gunzip the file + .gz<\/p>\n

catMaybeCompressed( FILENAME<\/small> )<\/p>\n

cat_ alike. If the file is not found, tries to gunzip the file + .gz<\/p>\n

SEE ALSO <\/a> <\/h2>\n

MDK::Common<\/p>\n

\n","protected":false},"excerpt":{"rendered":"

MDK::Common::File \u2212 miscellaneous file\/filename manipulation functions <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[3007,3675],"class_list":["post-7361","post","type-post","status-publish","format-standard","hentry","category-sin-categoria","tag-man3","tag-mdkcommonfile"],"gutentor_comment":0,"_links":{"self":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts\/7361","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/comments?post=7361"}],"version-history":[{"count":0,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts\/7361\/revisions"}],"wp:attachment":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/media?parent=7361"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/categories?post=7361"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/tags?post=7361"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}