Changeset 2543


Ignore:
Timestamp:
Jan 12, 2010, 2:42:48 AM (9 years ago)
Author:
bruno
Message:

Patch from Rogério Brito rbrito_at_ime.usp.br which fixes errors in man pages format

Location:
branches/2.2.9/mondo-doc
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • branches/2.2.9/mondo-doc/mondoarchive.8

    r2492 r2543  
    2525
    2626.SH SYNOPSIS
    27 .B mondoarchive -O
     27.B mondoarchive \-O
    2828[
    2929.I options
    3030] : backup your PC
    3131.br
    32 .B mondoarchive -V
     32.B mondoarchive \-V
    3333[
    3434.I options
     
    4141non-Linux filesystems to CD's, tape, ISO images or an NFS mount. In the event of
    4242catastrophic data loss, you will be able to restore everything, taking a PC from
    43 bare metal to its original state if necessary. 
     43bare metal to its original state if necessary.
    4444
    4545.PP
     
    6060
    6161.PP
    62 Call mondoarchive 
     62Call mondoarchive
    6363.BR without
    64 .BR flags 
     64.BR flags
    6565to make it auto-detect as many settings as possible, ask you politely for the
    6666rest, and then backup and verify your OS or a subset thereof.
    6767
    6868.PP
    69 To restore data, either run 
     69To restore data, either run
    7070.I mondorestore
    7171from the command line or boot from the emergency media generated during
     
    7878
    7979.TP
    80 .BI "-c " speed
     80.BI "\-c " speed
    8181Use CD-R drive as backup device and its (write-once) disks as backup media.
    8282
    8383.TP
    84 .BI "-w " speed
     84.BI "\-w " speed
    8585Use CD-RW drive as backup device and its (write/rewrite) disks as backup media.
    8686Mondo will wipe media before writing to them.
    8787
    8888.TP
    89 .BI "-r "
     89.BI "\-r "
    9090Use DVD drive as backup device and its disks as backup media. Growisofs decides
    9191on the best speed for your drive. Note that calling mondoarchive
    9292.B using sudo when writing to DVDs will fail
    93 because growisofs does not support this - see the growisofs manpage for
     93because growisofs does not support this \- see the growisofs manpage for
    9494details.
    9595
    9696.TP
    97 .BI "-C " speed
     97.BI "\-C " speed
    9898Use CD-R drive as a streaming device, almost like a tape streamer. Use
    9999write-once disks as backup media.
     
    101101
    102102.TP
    103 .BI "-p " prefix
    104 Use 
    105 .B prefix 
     103.BI "\-p " prefix
     104Use
     105.B prefix
    106106to generate the name of your ISO images.
    107107By default, mondoarchive names images mondorescue-1.iso, mondorescue-2.iso, ...
    108 Using 
    109 .B -p machine
     108Using
     109.B \-p machine
    110110will name your images machine-1.iso, machine-2.iso, ...
    111111
    112112.TP
    113 .BI "-i "
     113.BI "\-i "
    114114Use ISO files (CD images) as backup media. This is good for backing up your
    115115system to a spare hard drive. The
     
    118118
    119119.TP
    120 .BI "-n " mount
     120.BI "\-n " mount
    121121Use files residing on a remote share as backup media.
    122122.I mount
     
    130130
    131131.TP
    132 .BI "-t "
     132.BI "\-t "
    133133Use tape streamer as backup device and its tapes as backup media.
    134134
    135135.TP
    136 .BI "-U "
     136.BI "\-U "
    137137Use a generic USB device as backup device. Use this if you want to write
    138 your backup to a USB key or USB disk, which will be make bootable. 
     138your backup to a USB key or USB disk, which will be make bootable.
    139139The USB device should be attached to the system in order for this to work and
    140140its device name passed to the
    141 .BR \-d 
     141.BR \-d
    142142option. Do not use the partition name, but the raw device name (/dev/sda e.g.)
    143143.B WARNING: All the data on the related device will be removed.
    144144
    145145.TP
    146 .BI "-u "
     146.BI "\-u "
    147147Use a generic streaming device as backup device. Use this if you want to write
    148148your backup to a device that is not directly support by mondoarchive. This will
     
    152152.SH MAJOR OPTIONS
    153153.TP 13
    154 .BI "-D "
     154.BI "\-D "
    155155Make a differential backup: examine the filesystem and find which files have
    156156changed since the last full backup was carried out. Backup only those files.
    157157
    158158.TP
    159 .BI "-E " "\*(lqpath ...\*(rq"
     159.BI "\-E " "\*(lqpath ...\*(rq"
    160160Exclude path(s) from backup. The paths should be separated with a whitespace and surrounded by quotes.
    161161This is the prefered and recommended option when doing partial archiving.
     
    167167the mountlist. NB: If you exclude /dev/sdd4 then the /dev entry itself will
    168168still be backed up, even though the mountlist entry will be suppressed.
    169 N.B.: If you specify a directory with a final / its content will be archived so it won't do what you expect.
    170 You may also specify full disk device to this option as with -E \*(lq/dev/sda /dev/cciss/c0d0\*(rq
     169N.B.: If you specify a directory with a final / its content will be
     170archived so it won't do what you expect.
     171You may also specify full disk device to this option as with \-E
     172\*(lq/dev/sda /dev/cciss/c0d0\*(rq
    171173
    172174.TP
    173175.BI "-I " "\*(lqpath ...\*(rq"
    174 Include paths(s) in backup. This option is mainly use to perform tests in order to reduce the time taken by the archiving operation.
    175 The default backup path is \*(lq/\*(rq but you may specify alternatives, e.g. -I \*(lq/home /etc\*(rq to override that.
    176 You may also specify full disk device to this option as with -I \*(lq/dev/sda /dev/cciss/c0d0\*(rq
     176Include paths(s) in backup. This option is mainly use to perform tests
     177in order to reduce the time taken by the archiving operation.
     178The default backup path is \*(lq/\*(rq but you may specify alternatives,
     179e.g. \-I \*(lq/home /etc\*(rq to override that.
     180You may also specify full disk device to this option as with \-I
     181\*(lq/dev/sda /dev/cciss/c0d0\*(rq
    177182N.B.: When using the
    178183.BR \-I
    179 option with the 
     184option with the
    180185.BR \-E
    181 option, the -E content should be subdirectories of those mentioned in the -I only, as -I takes precedence.
     186option, the \-E content should be subdirectories of those mentioned in
     187the \-I only, as -I takes precedence.
    182188
    183189.TP
    184190.BI "-J " "file"
    185191Specify an explicit list of files and directories to include in a plain text file, one item
    186 (file or directory) per line. Beware that directories placed in that file are not managed recursively contrary to what is done with the -I option.
     192(file or directory) per line. Beware that directories placed in that file are not managed recursively contrary to what is done with the \-I option.
    187193
    188194.TP
     
    206212for processing by an 'expect' wrapper, enabling the user to backup nightly via
    207213a cron job. However, if you want to run this program with an attractive but
    208 non-cron-friendly interface then use '-g'.
     214non-cron-friendly interface then use '\-g'.
    209215
    210216.TP
    211217.BI "-k " "path"
    212218Path of user's kernel. If you are a Debian (<3.0) or Gentoo (<1.4) user then specify
    213 .B -k FAILSAFE
     219.B \-k FAILSAFE
    214220as your kernel. Otherwise, you will rarely need this option.
    215221
     
    217223.BI "-m "
    218224Manual (not self-retracting) CD trays are often found on laptops. If you are
    219 a laptop user, your CD burner has BurnProof technology or you experience 
    220 problems with mondo then please call mondoarchive with this switch. 
     225a laptop user, your CD burner has BurnProof technology or you experience
     226problems with mondo then please call mondoarchive with this switch.
    221227
    222228.TP
     
    248254CD burner using a non-standard command.
    249255.B -A
    250 understands two tokens - _ISO_ and _CD#_ - which will be translated into the
     256understands two tokens \- _ISO_ and _CD#_ - which will be translated into the
    251257ISO's filename and its index number (1, 2, ...) respectively. So, you could use
    252 .I -A 'foobackup _ISO_; rm -f _ISO_'
     258.I \-A 'foobackup _ISO_; rm \-f _ISO_'
    253259to feed each ISO to some magical new backup tool.
    254260
     
    256262.BI "-B " "command"
    257263This command will be called before each CD/NFS/ISO file is written. See
    258 .B -A
     264.B \-A
    259265for more information.
    260266
     
    277283.TP
    278284.BI "-R "
    279 EXPERIMENTAL. Do not use in mission-critical environments. Star is an alternative to afio. Mondo now supports POSIX ACLs and extended attributes, so -R is essentially redundant for now.
     285EXPERIMENTAL. Do not use in mission-critical environments. Star is an
     286alternative to afio. Mondo now supports POSIX ACLs and extended
     287attributes, so \-R is essentially redundant for now.
    280288
    281289.TP
    282290.BI "-P " "tarball"
    283291Post-nuke tarball. If you boot into Nuke Mode and everything is restored
    284 successfully then the 
     292successfully then the
    285293.I post-nuke
    286294script will be sought and executed if found. This is useful for post-restore
     
    288296just the
    289297.I post-nuke
    290 script (or binary, or whatever it is) but also any files it requires. 
     298script (or binary, or whatever it is) but also any files it requires.
    291299
    292300.TP
    293301.BI "-S " "path"
    294 Specify the full pathname of the scratchdir, the directory where ISO images are built before being
    295 archived. If you have plenty of RAM and want to use a ramdisk for scratch
    296 space, specify its path here.
     302Specify the full pathname of the scratchdir, the directory where ISO
     303images are built before being archived. If you have plenty of RAM and
     304want to use a ramdisk for scratch space, specify its path here.
    297305
    298306.TP
    299307.BI "-T " "path"
    300 Specify the full pathname of the tempdir, the directory where temporary files (other than ISO images
    301 being assembled) are stored. See
    302 .B -S
     308Specify the full pathname of the tempdir, the directory where temporary
     309files (other than ISO images being assembled) are stored. See
     310.B \-S
    303311
    304312.TP
     
    307315this unless you have really great boot disks in your hand and you are an anally
    308316retentive SOB who can't wait 2 minutes for Mindi to run in the background. If
    309 you use -W then you'd better know what the hell you're doing, okay?
     317you use \-W then you'd better know what the hell you're doing, okay?
    310318
    311319.TP
     
    330338the boot loader can usually be discovered. If you specify RAW then the MBR will
    331339be backed up and restored byte-for-byte without any analysis. It is likely that
    332 you will also need to specify the boot device with -f <dev>. ELILO is mandatory
     340you will also need to specify the boot device with \-f <dev>. ELILO is mandatory
    333341for IA64 machines.
    334342
     
    343351.TP
    344352.BI "-z "
    345 Use extended attributes and acl for each file and store them in the backup media. Use this option if you use SElinux e.g. but it will slow down backup and restore time of course.
     353Use extended attributes and acl for each file and store them in the
     354backup media. Use this option if you use SElinux e.g. but it will slow
     355down backup and restore time of course.
    346356
    347357
    348358.SH DIAGNOSTICS
    349359Mondo generates one additional, and extremely important file:
    350 .BI /var/log/mondoarchive.log.
    351 When seeking technical support, attach this file to your email.
    352 
     360.BI /var/log/mondoarchive.log.
     361When seeking technical support, attach this file to your email.
    353362
    354363
     
    359368support questions.
    360369
     370
    361371.SH NOTES
    362 A link to Mondo's HTML-based manual (by Bruno Cornec, Mikael Hultgren, Cafeole, Randy Delphs,
    363 Stan Benoit, and Hugo Rabson) may be found at
     372A link to Mondo's HTML-based manual (by Bruno Cornec, Mikael Hultgren,
     373Cafeole, Randy Delphs, Stan Benoit, and Hugo Rabson) may be found at
    364374.I http://www.mondorescue.org/docs.shtml
    365 - or in
     375\- or in
    366376.I /usr/share/doc/mondo-x.xx
    367377on your hard drive.
     
    370380It is recommend that your system has more than 64 MB ram. SCSI device order
    371381change with nuke can have unexpected results. It is recommended you use expert
    372 mode with drastic hardware reconfigurations. 
     382mode with drastic hardware reconfigurations.
    373383
    374384.SH EXAMPLES
     
    376386.BI ISO:
    377387Backup to a directory; note that /mnt/foo's contents will be backed up except
    378 for its ISO's unless you exclude it, as follows:-
     388for its ISO's unless you exclude it, as follows:
    379389.br
    380390.I "mondoarchive -Oi -d /mnt/foo -E '/mnt/foo /mnt/foo2' -p \`hostname\`-\`date +%Y-%m-%d\`"
     
    438448Backup PC to a Software Raid mount point, iso size 700mb:
    439449.br
    440 .I "mondoarchive -O -s 700m -d /mnt/raid" 
     450.I "mondoarchive -O -s 700m -d /mnt/raid"
    441451
    442452
     
    444454afio(1), bzip2(1), find(1), mindi(8), mondorestore(8).
    445455.SH AUTHORS
    446 Bruno Cornec (lead-development) 
     456Bruno Cornec (lead-development)
    447457.I "bruno_at_mondorescue.org"
    448458.br
    449 Andree Leidenfrost (co-developer) 
     459Andree Leidenfrost (co-developer)
    450460.I "aleidenf_at_bigpond.net.au"
    451461.br
     
    464474.br
    465475See mailing list at http://www.mondorescue.org for technical support.
    466 .
  • branches/2.2.9/mondo-doc/mondorestore.8

    r2380 r2543  
    2525
    2626.SH SYNOPSIS
    27 .B mondorestore [-p prefix][-K loglevel][-i][-U]...
     27.B mondorestore [\-p prefix][\-K loglevel][\-i][\-U]...
    2828: restore your PC
    2929
     
    3131.PP
    3232.I mondorestore
    33 restores data previously backed up with 
     33restores data previously backed up with
    3434.I mondoarchive.
    3535
    3636.
    37 Note that mondorestore will usually automatically be called when booting a 
     37Note that mondorestore will usually automatically be called when booting a
    3838MondoRescue medium. The only exception is booting a MondoRescue medium in
    3939.B Expert
     
    4242.TP
    4343.BI "-p " prefix
    44 Use 
    45 .B prefix 
     44Use
     45.B prefix
    4646to specify the name of your ISO images.
    4747By default, mondorestore names images mondorescue-1.iso, mondorescue-2.iso, ...
    48 Using 
    49 .B -p machine
     48Using
     49.B \-p machine
    5050.B mondorestore
    5151will use images named machine-1.iso, machine-2.iso, ...
     
    5555Use ISO files (CD images) as restore media. This is good when having backed up your
    5656system to a spare hard drive. The
    57 .B -n
     57.B \-n
    5858switch is a wiser choice if you plan to restore from a remote filesystem.
    5959
     
    7575The USB device should be attached to the system in order for this to work and
    7676its device name passed to the
    77 .BR \-d 
     77.BR \-d
    7878option.
    7979
     
    8888.BI "-E " "\*(lqpath ...\*(rq"
    8989Exclude path(s) from restore (future dev). The paths should be separated with a whitespace.
    90 /mnt/cdrom, /proc, /sys, /tmp). For example, if you are restoring up from an NFS mount but you
    91 do not want to restore some content, exclude it with that switch.
     90/mnt/cdrom, /proc, /sys, /tmp). For example, if you are restoring up
     91from an NFS mount but you do not want to restore some content, exclude it with that switch.
    9292
    9393.TP
    9494.BI "-I " "\*(lqpath ...\*(rq"
    95 Include paths(s) to restore (future dev). 
     95Include paths(s) to restore (future dev).
    9696
    9797.TP
    9898.BI "-J " "file"
    99 Specify an explicit list of files and directories to restore in a plain text file, one item
    100 (file or directory) per line. Beware that directories placed in that file are not managed recursively contrary to what is done with the -I option.
     99Specify an explicit list of files and directories to restore in a plain
     100text file, one item (file or directory) per line. Beware that
     101directories placed in that file are not managed recursively contrary to
     102what is done with the \-I option.
    101103
    102104.TP
     
    117119.BI "-m "
    118120Manual (not self-retracting) CD trays are often found on laptops. If you are
    119 a laptop user, your CD burner has BurnProof technology or you experience 
    120 problems with mondo then please call mondorestore with this switch. 
     121a laptop user, your CD burner has BurnProof technology or you experience
     122problems with mondo then please call mondorestore with this switch.
    121123
    122124.TP
     
    132134.TP
    133135.BI "-T " "path"
    134 Specify the full pathname of the tempdir, the directory where temporary files 
    135 are stored. 
     136Specify the full pathname of the tempdir, the directory where temporary files
     137are stored.
    136138
    137139.TP
     
    144146.TP
    145147.BI "-e "
    146 Don't eject the CD or tape when restoring... 
     148Don't eject the CD or tape when restoring...
    147149
    148150.TP
     
    161163.TP
    162164.BI "-z "
    163 Use extended attributes and acl for each file and store them in the backup media. Use this option if you use SElinux e.g. but it will slow down backup and restore time of course.
     165Use extended attributes and acl for each file and store them in the
     166backup media. Use this option if you use SElinux e.g. but it will slow
     167down backup and restore time of course.
    164168
    165169.TP
    166170.BI "-Z "
    167171Specify mondorestore mode. Mode could be one of
    168 .IR nuke: 
     172.IR nuke:
    169173This mode restore everything like on the original system with no/minimal questions
    170 .IR interactive: 
     174.IR interactive:
    171175This mode asks all the questions to the user
    172 .IR compare: 
     176.IR compare:
    173177This mode just compares the system with the backup
    174 .IR iso: 
     178.IR iso:
    175179This mode restores from iso images, instead of real media
    176 .IR isonuke: 
     180.IR isonuke:
    177181This mode restores from iso images, instead of real media, with no/minimal questions
    178 .IR mbr: 
     182.IR mbr:
    179183This mode just restores the MBR (Master Boot Record)
    180184
     
    182186.SH DIAGNOSTICS
    183187mondorestore generates an Extremely important file:
    184 .BI /var/log/mondorestore.log. 
    185 When seeking technical support, attach this file to your email. 
     188.BI /var/log/mondorestore.log.
     189When seeking technical support, attach this file to your email.
    186190
    187191.SH FILES
    188192.IR /var/log/mondorestore.log
    189 This log contains important information required to analyse mondorestore problem
    190 reports. Mondo support highly recommends sending this file with support
    191 questions. It's located under /tmp during the restore process and moved under /var/log at the end.
     193This log contains important information required to analyse mondorestore
     194problem reports. Mondo support highly recommends sending this file with
     195support questions. It's located under /tmp during the restore process
     196and moved under /var/log at the end.
    192197
    193198.SH NOTES
    194 A link to Mondo's HTML-based manual (by Bruno Cornec, Mikael Hultgren, Cafeole, Randy Delphs,
    195 Stan Benoit, and Hugo Rabson) may be found at
     199A link to Mondo's HTML-based manual (by Bruno Cornec, Mikael Hultgren,
     200Cafeole, Randy Delphs, Stan Benoit, and Hugo Rabson) may be found at
    196201.I http://www.mondorescue.org/docs.shtml
    197 - or in
     202\- or in
    198203.I /usr/share/doc/mondo-x.xx
    199204on your hard drive.
     
    202207It is recommend that your system has more than 64 MB ram. SCSI device order
    203208change with nuke can have unexpected results. It is recommended you use expert
    204 mode with drastic hardware reconfigurations. 
     209mode with drastic hardware reconfigurations.
    205210
    206211.SH "SEE ALSO"
    207212afio(1), bzip2(1), find(1), mindi(8), mondoarchive(8).
    208213.SH AUTHORS
    209 Bruno Cornec (lead-development) 
     214Bruno Cornec (lead-development)
    210215.I "bruno_at_mondorescue.org"
    211216.br
    212 Andree Leidenfrost (co-developer) 
     217Andree Leidenfrost (co-developer)
    213218.I "aleidenf_at_bigpond.net.au"
    214219.br
     
    227232.br
    228233See mailing list at http://www.mondorescue.org for technical support.
    229 .
Note: See TracChangeset for help on using the changeset viewer.