README

   1
   2 Caution:  This is a Work-In-Progress!  There is a very high likelyhood of
   3         castfs deleting your entire filesystem, especially if you dare to
   4         run it as root.  Please test it and convince yourself it is correct
   5         before proceeding.  Feel free to offer any constructive comments.
   6
   7         Dale E. Edmons (aka linuxfan)
   8
   9
  10 --- Copy And Stage Things File System ---
  11 --- README ---
  12
  13 castfs is a fuse filesystem written in C and is used for capturing filesystem
  14 calls for your root filesystem and staging any modifications or additions to
  15 the root filesystem.
  16
  17 The main purpose for this filesystem is to be able to invoke the filesystem in
  18 the Source Mage package manager (sorcery) to install packages without blowing
  19 over files in your main system. However, there maybe other uses in the future.
  20
  21 -- BUILD INSTRUCTIONS --
  22
  23 Simple build instructions:
  24
  25     $ make
  26
  27 There are various flags to pass to the Makefile if you want to add CFLAGS or
  28 LDFLAGS use the make variables EXTRA_CFLAGS and EXTRA_LDFLAGS
  29
  30 -- INSTALL INSTRUCTIONS --
  31
  32 Simple install instructions:
  33
  34     # make install
  35
  36 There are various flags to pass to the Makefile to install to different prefix
  37 locations use the PREFIX make variable to do this.
  38
  39 -- USAGE INSTRUCTIONS --
  40
  41 There are some simple run and stop scripts in the source directory to show usage
  42 of the filesystem after building castfs do:
  43
  44     # ./run-castfs.sh
  45     # chroot test_dirs/mount
  46     # < do stuff >
  47     # exit
  48     # ./stop-castfs.sh
  49
  50 After this you should find all your modified files in test_dirs/stage directory.
  51
  52 -- More Advanced Usage --
  53
  54 The castfs needs two environmental variables:
  55
  56     CASTFS_LOGFILE
  57     CASTFS_DBGLVL
  58
  59 The log file variable is the location where the log file that castfs
  60 will log filesystem function calls calls into the utilities file etc.
  61
  62 The debug level variable is actually a mask to dump particular parts of
  63 castfs to the log file, either just the filesystem calls or just the
  64 hash calls or just the util calls and so on.
  65
  66 There's two ways you can use castfs either call the binary directly or
  67 mount it via the mount command:
  68
  69     # castfs /mnt/cast-fs -o stage=/mnt/cast-fs-stage
  70     or
  71     # mount -t fuse -o stage=/mnt/cast-fs-stage castfs /mnt/cast-fs
  72
  73 -- Bugs Problems --
  74
  75 You can contact the maintainers:
  76
  77 David Brown <dmlb2000@gmail.com>
  78