FileUtils

frozen_string_literal: true

fileutils.rb

Copyright © 2000-2007 Minero Aoki

This program is free software. You can distribute/modify this program under the same terms of ruby.

module FileUtils

Namespace for several file utility methods for copying, moving, removing, etc.

Module Functions

require 'fileutils'
FileUtils .cd (dir, options )
FileUtils .cd (dir, options ) {|dir| block }
FileUtils .pwd ()
FileUtils .mkdir (dir, options )
FileUtils .mkdir (list, options )
FileUtils .mkdir_p (dir, options )
FileUtils .mkdir_p (list, options )
FileUtils .rmdir (dir, options )
FileUtils .rmdir (list, options )
FileUtils .ln (target, link , options )
FileUtils .ln (targets, dir, options )
FileUtils .ln_s (target, link , options )
FileUtils .ln_s (targets, dir, options )
FileUtils .ln_sf (target, link , options )
FileUtils .cp (src, dest, options )
FileUtils .cp (list, dir, options )
FileUtils .cp_r (src, dest, options )
FileUtils .cp_r (list, dir, options )
FileUtils .mv (src, dest, options )
FileUtils .mv (list, dir, options )
FileUtils .rm (list, options )
FileUtils .rm_r (list, options )
FileUtils .rm_rf (list, options )
FileUtils .install (src, dest, options )
FileUtils .chmod (mode, list, options )
FileUtils .chmod_R (mode, list, options )
FileUtils .chown (user, group, list, options )
FileUtils .chown_R (user, group, list, options )
FileUtils .touch (list, options )

The options parameter is a hash of options, taken from the list :force, :noop, :preserve, and :verbose. :noop means that no changes are made. The other three are obvious. Each method documents the options that it honours.

All methods that have the concept of a "source" file or directory can take either one file or a list of files in that argument. See the method documentation for examples.

There are some `low level’ methods, which do not accept any option:

FileUtils .copy_entry (src, dest, preserve = false, dereference = false)
FileUtils .copy_file (src, dest, preserve = false, dereference = true)
FileUtils .copy_stream (srcstream, deststream)
FileUtils .remove_entry (path, force = false)
FileUtils .remove_entry_secure (path, force = false)
FileUtils .remove_file (path, force = false)
FileUtils .compare_file (path_a, path_b)
FileUtils .compare_stream (stream_a, stream_b)
FileUtils .uptodate? (file, cmp_list)

module FileUtils::Verbose

This module has all methods of FileUtils module, but it outputs messages before acting. This equates to passing the :verbose flag to methods in FileUtils.

module FileUtils::NoWrite

This module has all methods of FileUtils module, but never changes files/directories. This equates to passing the :noop flag to methods in FileUtils.

module FileUtils::DryRun

This module has all methods of FileUtils module, but never changes files/directories. This equates to passing the :noop and :verbose flags to methods in FileUtils.

Related methods