overlay-diskfile.8.adoc

   1 overlay-diskfile(8)
   2 ===================
   3 :doctype: manpage
   4 :revdate: {sys:date "+%Y-%m-%d %H:%M:%S"}
   5 :COLON: :
   6 :EQUALS: =
   7 :BANG: !
   8
   9 NAME
  10 ----
  11 overlay-diskfile - Support for using diskfile filesystem.
  12
  13 SYNOPSIS
  14 --------
  15 *overlay-diskfile* _mount/path_ [ _diskfile_ [ _index_ ] ]
  16
  17 DESCRIPTION
  18 -----------
  19
  20 *overlay-diskfile* is a support script for pre-mounting a diskfile to
  21 provide the LOWER or UPPER filesystem for a subhost. It is typically
  22 used in the subhost configuration to be invoked as part of determining
  23 the filesystem path.
  24
  25 OPTIONS
  26 -------
  27
  28 no options.
  29
  30 EXAMPLES
  31 --------
  32
  33 .Use a whole diskfile filesystem as LOWER
  34 ====
  35 ----
  36 LOWER=!overlay-diskfile mnt/ disk.img
  37 ----
  38 ====
  39
  40 The above mounts the disk.img filesystem onto +mnt+ and provides that
  41 as the LOWER filesystem.
  42
  43 .Use a diskfile partition 2 as LOWER
  44 ====
  45 ----
  46 LOWER=!overlay-diskfile mnt/ disk.img 2
  47 ----
  48 ====
  49
  50 The above mounts the second partition onto +mnt+ and provides that as
  51 the LOWER filesystem.
  52
  53 .Use a subtree of a diskfile partition 2 as LOWER
  54 ====
  55 ----
  56 LOWER=!overlay-diskfile mnt/some/path disk.img 2
  57 ----
  58 ====
  59
  60 The above mounts the second partition onto +mnt+ and provides the path
  61 +mnt/some/path+ that as the LOWER filesystem.
  62
  63 .Use second partition diskfile filesystem subtrees for UPPER and WORK.
  64 ====
  65 ----
  66 UPPER=!overlay-diskfile mnt/some/upper/path disk.img 2
  67 WORK= mnt/some/work/path
  68 ----
  69 ====
  70
  71 The above mounts the second partition of disk.img and uses
  72 +mnt/some/upper/path+ as UPPER and +mnt/some/work/path+ as WORK. Note
  73 that UPPER and WORK must always be subtrees from the same filesystem.
  74
  75
  76 SEE ALSO
  77 --------
  78
  79 *overlay-boot*, *overlay-stop*