| | 1 | == Compliance with FHS 2.3 == |
| | 2 | |
| | 3 | Mondo Rescue aims to be compliant with the FHS (currently 2.3). Details are outlined below. |
| | 4 | |
| | 5 | === Default Exclusion Rules === |
| | 6 | |
| | 7 | The following directories will by default be EXCLUDED by mondoarchive: |
| | 8 | |
| | 9 | * /media (currently only /media/floppy) |
| | 10 | This directory is supposed to contain only removable media. See here for details: |
| | 11 | [http://www.pathname.com/fhs/pub/fhs-2.3.html#VARCACHEAPPLICATIONCACHEDATA] |
| | 12 | * /proc[[BR]] |
| | 13 | Pseudo filesystem. |
| | 14 | * /sys |
| | 15 | Pseudo filesystem. |
| | 16 | * /tmp (currently under discussion) |
| | 17 | To be emptied between reboots and consequently to be emptied in a restore situation. See here for more details: |
| | 18 | [http://www.pathname.com/fhs/pub/fhs-2.3.html#VARCACHEAPPLICATIONCACHEDATA]. In particular: "Although data stored in /tmp may be deleted in |
| | 19 | a site-specific manner, it is recommended that files and directories located in /tmp be deleted whenever the system is booted." |
| | 20 | * /var/cache/mondo (not implemented yet) |
| | 21 | This is where mondoarchvie should put scratch, temp, image and iso files by default. See here for why: |
| | 22 | [http://www.pathname.com/fhs/pub/fhs-2.3.html#VARCACHEAPPLICATIONCACHEDATA] |
| | 23 | * /var/cache/mindi (not implemented yet) |
| | 24 | This is where mindi should put boot images by default. See here for why: |
| | 25 | [http://www.pathname.com/fhs/pub/fhs-2.3.html#VARCACHEAPPLICATIONCACHEDATA] |
| | 26 | |
| | 27 | The following directories will by default '''NOT''' be excluded by mondoarchive: |
| | 28 | * /var/tmp |
| | 29 | The contents of /var/temp is to be preserved between reboots (as opposed to /tmp), so this is what should also happen during a restore. |
| | 30 | See here for details: [http://www.pathname.com/fhs/pub/fhs-2.3.html#VARCACHEAPPLICATIONCACHEDATA] |
| | 31 | |
| | 32 | == Installation Directories == |
| | 33 | |
| | 34 | |
| | 35 | Distribution packages will install under /usr, builts from the tarballs with install under /usr/local. The following only deals with /usr. |
| | 36 | |
| | 37 | == File Locations == |
| | 38 | |
| | 39 | * binaries: '''/usr/sbin''' |
| | 40 | * configuration: '''/etc/[mindi|mondo]''' (only mindi used ATM) |
| | 41 | * documentation: '''/usr/share/doc/[mindi|mondo(|mondo-doc)]''' |
| | 42 | * manpages: '''/usr/share/man/man8''' |
| | 43 | * package-specific other files: |
| | 44 | * binary files: '''/usr/lib/[mindi|mondo]''' |
| | 45 | * non-binary (platform-independent) files: '''/usr/share/[mindi|mondo]''' |
| | 46 | * shared libraries: '''/usr/lib''' (shared libraries turned-off in 2.0.8) |
| | 47 | * temporary files, archive and boot images: '''/var/cache/[mindi|mondo]''' |
| | 48 | (not implemented yet; for mondo, it's currently /var/cache/mondo-archive, for mindi this doesn't exist): |
| | 49 | * boot images created by mindi: '''/var/cache/mindi/images''' (this is currently /root/images/mindi) |
| | 50 | * data images created by mondo: '''/var/cache/mondo/images''' |
| | 51 | * mondo tmp directory: '''/var/cache/mondo/tmp''' |
| | 52 | * mondo scratch directory: '''/var/cache/mondo/tmp''' |
| | 53 | |
| | 54 | == Discussion == |
| | 55 | |
| | 56 | '-d' switch should really only allow manipulation of location for data images as it is the case now, i.e. '-d' should allow for changing '''/var/cache/mondo/images''' to a different location. Boot images should always go to '''/var/cache/mindi/images'''. The reasoning behind it is consistency on the one hand but allowing moving the potentially large contents of the '''/var/cache/mondo/images''' someplace else on the other. |
| | 57 | |
| | 58 | During restoration, mondorestore should use also '''/var/cache/mondo''' instead of '''/disponible'''. ''{Bruno: Is '''/disponible''' French for '''/tmp'''?} |
| | 59 | '' |
| | 60 | == GNU Coding Standards == |
| | 61 | |
| | 62 | The GNU project has defined a good set of coding standards over the years. The latest version can be found here: [http://www.gnu.org/prep/standards/standards.html]. In fact, these standards are not really specific to GNU but can be viewed as best practice for at least pretty much any C program - many of the points made applies regardless of the programming language. Mondo Rescue strives to adhere to the GNU Coding Standards unlesss there is a reason not to. |
| | 63 | |
| | 64 | getopt(3) and getopt_long(3) are the two standard function provided by the GNU C library for this purpose. See their manpages for details. |
| | 65 | |
| | 66 | == Processing Command Lines Parameters == |
| | 67 | |
| | 68 | Currently, we only support short command line switches, i.e. '-<single character>'. This does allow for compact invocation of our programs but is not very expressive. However, the GNU Coding Standards recommend the use of long options of the format '--<expressive expression>' besides the short ones for better trnsparency of the exact nature and working of the command invoked. |
| | 69 | |
| | 70 | == mondoarchive Command Line Options == |
| | 71 | |
| | 72 | Preliminary table of long command line options verus short ones. |
| | 73 | |
| | 74 | ||'''Short'''||'''Long'''||'''Done'''|| |
| | 75 | ||-O||--backup|| || |
| | 76 | ||-V||--verify|| || |
| | 77 | ||-c||--media-cd|| || |
| | 78 | ||-w||(to be deleted)|| || |
| | 79 | ||-r||(to be deleted)|| || |
| | 80 | ||-C||--media-cd-stream|| || |
| | 81 | ||-p||--prefix|| || |
| | 82 | ||-i||--media-iso|| || |
| | 83 | ||-n||--media-nfs|| || |
| | 84 | ||-t||--media-tape|| || |
| | 85 | ||-u||--media-stream-generic|| || |
| | 86 | ||-D||--differential|| || |
| | 87 | ||-E||--exclude|| || |
| | 88 | ||-I||--include|| || |
| | 89 | ||-J||-include-list|| || |
| | 90 | ||-N||--exclude-netmounts|| || |
| | 91 | ||-d||--backup-path|| || |
| | 92 | ||-g||(to be deleted)|| || |
| | 93 | ||-k||--kernel-path|| || |
| | 94 | ||-m||--cd-drive-safe-mode|| || |
| | 95 | ||-o||--use-lilo|| || |
| | 96 | ||-s||--media-size|| || |
| | 97 | ||-x||--partitions-to-archive|| || |
| | 98 | ||-A||--run-after each-media|| || |
| | 99 | ||-B||--run-before-each-media|| || |
| | 100 | ||-F||--dont-ask-for-floppies|| || |
| | 101 | ||-H||--non-interactive-restore|| || |
| | 102 | ||-L||--use-lzop|| || |
| | 103 | ||-R||--use-star|| || |
| | 104 | ||-P||--run-post-nuke|| || |
| | 105 | ||-S||--scratch-dir|| || |
| | 106 | ||-T||--temp-dir|| || |
| | 107 | ||-W||--not-bootable|| || |
| | 108 | ||-b||--tape-blocksize|| || |
| | 109 | ||-e||--dont-eject|| || |
| | 110 | ||-f||--mbr-device|| || |
| | 111 | ||-Q||--bootloader-info|| || |
| | 112 | ||-K||--loglevel|| || |
| | 113 | ||-h||--help or --usage|| || |
| | 114 | ||-v||--version|| || |
| | 115 | |
| | 116 | '''Notes:''' --help and --version recommended by GNU Coding Standards, |
| | 117 | |
| | 118 | == mondorestore Command Line Options == |
| | 119 | |
| | 120 | Preliminary table of long command line options verus short ones. |
| | 121 | |
| | 122 | ||'''Short'''||'''Long'''||'''Done'''|| |
| | 123 | ||-h||--help or --usage|| || |
| | 124 | ||-v||--version|| || |
| | 125 | |
| | 126 | == mindi Command Line Options == |
| | 127 | |
| | 128 | Preliminary table of long command line options verus short ones. |
| | 129 | |
| | 130 | ||'''Short'''||'''Long'''||'''Done'''|| |
| | 131 | ||-f||--find-kernel|| || |
| | 132 | ||-m||--make-mount-list|| || |
| | 133 | ||-s||--max-compressed-size|| || |
| | 134 | ||-c||--custom|| || |
| | 135 | ||-h||--help or --usage|| || |
| | 136 | ||-v||--version|| || |
