doc/Makefile: fix non posix shell syntax
[grml-autoconfig.git] / doc / mkpersistenthome.1.txt
1 mkpersistenthome(1)
2 ===================
3
4 Name
5 ----
6 mkpersistenthome - create persistent home directory
7
8 Synopsis
9 --------
10
11 mkpersistenthome
12
13 About
14 -----
15
16 You have a local partition you would like to use as your home-directory?  Just
17 use the interactive script called 'mkpersistenthome'. It will either create a
18 file named grml.img on the specified partition or create a partition using the
19 ext2 filesystem (you can specify the option in a dialog inside the program).
20 grml.img is a loopback device which size you can specify manually.  It is
21 possible to scan through the partitions to identify the appropriate partition.
22 To use a home-directory located on your hard-drive use the appropriate boot
23 parameter on bootprompt:
24
25   home=/dev/sda3    =>   use /dev/sda3 as the homepartition
26   home=scan         =>   scan through the available partitions and search for file grml.img
27
28 Use persistent home directory
29 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
30
31 You want to use a persistent home directory which includes all the files located
32 in $HOME. Use the script mkpersistenthome to create such a persistent home
33 directory. You have the options to either use a specific partition as your home
34 directory or add a loopback file named grml.img on the specified partition (the
35 default).
36
37 TIP: /dev/external in the partition selection of mkpersistenthome is an usb
38 device without partitions. /dev/external1 corresponds to the first partition on
39 an usb device (usually an usb stick).
40
41 After running the script mkpersistenthome you can use the boot parameter home to
42 activate the home directory. If you are using the option with the loopback file
43 (grml.img) you can boot via:
44
45   grml home=scan
46
47 which will scan through the partitions and if a file grml.img is found it will
48 be mounted as your $HOME-directory. If you want to use a partition as your home
49 directory specify the device as an option. If you want to use /dev/sda2 as your
50 $HOME boot via:
51
52   grml home=/dev/sda2
53
54 Notice: the files located in /etc/skel will be copied to the partition (but will
55 not overwrite any files).
56
57 Bugs
58 ----
59 If you find a bug please report it. See link:http://grml.org/bugs/ for details
60 about how to report bugs.
61
62 See also
63 --------
64 grml-autoconfig(1), grml-autoconfig(8), restore-config(1), save-config(1)
65
66 Author
67 ------
68 (c) 2005++, Michael Prokop <mika@grml.org>