diff options
| author |   Christopher Harvey <chris@basementcode.com> | 2010-06-01 11:13:01 -0400 |
|---|---|---|
| committer | Christopher Harvey <chris@basementcode.com> | 2010-06-01 11:13:01 -0400 |
| commit | 2609bb16a7114f3e0e753360a6155488e157ad6c (patch) | |
| tree | 78bf706dd2ef2c6985b2fddd717a921fbeb9e8ca | |
| parent | Documentation files are now located relative to the module root directory. (diff) | |
| download | ventoo-2609bb16a7114f3e0e753360a6155488e157ad6c.tar.gz ventoo-2609bb16a7114f3e0e753360a6155488e157ad6c.tar.bz2 ventoo-2609bb16a7114f3e0e753360a6155488e157ad6c.zip | |
Added fstab documentation. It is incomplete, but useful, and shows that displaying documentation works.
| -rw-r--r-- | modules/fstab/dumpDoc.html | 8 | ||||
| -rw-r--r-- | modules/fstab/fileDoc.html | 3 | ||||
| -rw-r--r-- | modules/fstab/main.xml | 12 | ||||
| -rw-r--r-- | modules/fstab/optsDoc.html | 23 | ||||
| -rw-r--r-- | modules/fstab/specdoc.html | 3 | ||||
| -rw-r--r-- | modules/fstab/typeDoc.html | 14 |
6 files changed, 57 insertions, 6 deletions
diff --git a/modules/fstab/dumpDoc.html b/modules/fstab/dumpDoc.html new file mode 100644 index 0000000..e37f852 --- /dev/null +++ b/modules/fstab/dumpDoc.html @@ -0,0 +1,8 @@ +<html> +Adopted from <a href="http://www.tuxfiles.org/linuxhelp/fstab.html">http://www.tuxfiles.org/linuxhelp/fstab.html</a><br> +<b>Dump</b> and <b>fsck</b> options. Well, dump is a backup utility and fsck is a filesystem check utility. I won't discuss them in great length here (they would both need their own tuXfile), but I'll mention them, because otherwise you'd spend the rest of the day wondering what on God's green Earth do these things mean.<br><br> + +the <b>dump</b> option. Dump checks it and uses the number to decide if a filesystem should be backed up. If it's zero, dump will ignore that filesystem. If you take a look at the example fstab, you'll notice that the 5th column is zero in most cases.<br><br> + +The <b>fsck</b> option. fsck looks at the number in the 6th column to determine in which order the filesystems should be checked. If it's zero, fsck won't check the filesystem.<br><br> +</html> diff --git a/modules/fstab/fileDoc.html b/modules/fstab/fileDoc.html new file mode 100644 index 0000000..714e662 --- /dev/null +++ b/modules/fstab/fileDoc.html @@ -0,0 +1,3 @@ +<html> + The file node is a node that defines where a device is going to be mounted. The device is defined in the spec node. +</html> diff --git a/modules/fstab/main.xml b/modules/fstab/main.xml index f8157ad..82328c1 100644 --- a/modules/fstab/main.xml +++ b/modules/fstab/main.xml @@ -1,10 +1,10 @@ <VentooModule> <root mult="*"> - <spec mult="1"/> - <file mult="1"/> - <vfstype mult="1"/> - <opt mult="*"/> - <dump mult="1"/> - <passno mult="1"/> + <spec mult="1" docurl="specdoc.html"/> + <file mult="1" docurl="fileDoc.html"/> + <vfstype mult="1" docurl="typeDoc.html"/> + <opt mult="*" docurl="optsDoc.html"/> + <dump mult="1" docurl="dumpDoc.html"/> + <passno mult="1" docurl="dumpDoc.html"/> </root> </VentooModule>
\ No newline at end of file diff --git a/modules/fstab/optsDoc.html b/modules/fstab/optsDoc.html new file mode 100644 index 0000000..fab9fa7 --- /dev/null +++ b/modules/fstab/optsDoc.html @@ -0,0 +1,23 @@ +<html> +Adopted from <a href="http://www.tuxfiles.org/linuxhelp/fstab.html">http://www.tuxfiles.org/linuxhelp/fstab.html</a><br> +This node lists all the mount options for the device or partition. This is also the most confusing part in the fstab file, but knowing what some of the most common options mean, saves you from a big headache. Yes, there are many options available, but I'll take a look at the most widely used ones only. For more information, check out the man page of mount.<br><br> + +<b>auto</b> and <b>noauto</b> With the auto option, the device will be mounted automatically. auto is the default option. If you don't want the device to be mounted automatically, use the noauto option in /etc/fstab. With noauto, the device can be mounted only explicitly.<br><br> + +<b>user</b> and <b>nouser</b> These are very useful options. The user option allows normal users to mount the device, whereas nouser lets only the root to mount the device. nouser is the default, which is a major cause of headache for new Linux users. If you're not able to mount your cdrom, floppy, Windows partition, or something else as a normal user, add the user option into /etc/fstab.<br><br> + +<b>exec</b> and <b>noexec</b> exec lets you execute binaries that are on that partition, whereas noexec doesn't let you do that. noexec might be useful for a partition that contains binaries you don't want to execute on your system, or that can't even be executed on your system. This might be the case of a Windows partition. +<b>exec is the default option</b>, which is a good thing. Imagine what would happen if you accidentally used the noexec option with your Linux root partition...<br><br> + +<b>ro</b> Mount the filesystem read-only.<br><br> + +<b>rw</b> Mount the filesystem read-write. Again, using this option might cure the headache of many new Linux users who are tearing their hair off because they can't write to their floppies, Windows partitions, or something else.<br><br> + +<b>sync</b> and <b>async</b> How the input and output to the filesystem should be done. sync means it's done synchronously. In plain English, this means that when you, for example, copy a file to the floppy, the changes are physically written to the disk at the same time you issue the copy command.<br> + +However, if you have the async option in /etc/fstab, input and output is done asynchronously. Now when you copy a file to the disk, the changes may be physically written to it long time after issuing the command. This isn't bad, and may sometimes be favorable, but can cause some nasty accidents: if you just remove the floppy without unmounting it first, the copied file may not physically exist on the floppy yet!<br> + +async is the default. However, it may be wise to use sync with the floppy, especially if you're used to the way it's done in Windows and have a tendency to remove floppies before unmounting them first.<br><br> + +<b>defaults</b> Uses the default options that are rw, suid, dev, exec, auto, nouser, and async. +</html> diff --git a/modules/fstab/specdoc.html b/modules/fstab/specdoc.html new file mode 100644 index 0000000..0530951 --- /dev/null +++ b/modules/fstab/specdoc.html @@ -0,0 +1,3 @@ +<html> + The drive to mount. +</html> diff --git a/modules/fstab/typeDoc.html b/modules/fstab/typeDoc.html new file mode 100644 index 0000000..d7861c1 --- /dev/null +++ b/modules/fstab/typeDoc.html @@ -0,0 +1,14 @@ +<html> +Adopted from <a href="http://www.tuxfiles.org/linuxhelp/fstab.html">http://www.tuxfiles.org/linuxhelp/fstab.html</a><br> +This node specifies the filesystem type of the device or partition. Many different filesystems are supported but we'll take a look at the most common ones only.<br><br> + +<b>ext2</b> and <b>ext3</b> Very likely your Linux partitions are Ext3. Ext2 used to be the standard filesystem for Linux, but these days, Ext3 and ReiserFS are usually the default filesystems for almost every new Linux distro. Ext3 is a newer filesystem type that differs from Ext2 in that it's journaled, meaning that if you turn the computer off without properly shutting down, you shouldn't lose any data and your system shouldn't spend ages doing filesystem checks the next time you boot up.<br><br> + +<b>reiserfs</b> Your Linux partitions may very well be formatted as ReiserFS. Like Ext3, ReiserFS is a journaled filesystem, but it's much more advanced than Ext3. Many Linux distros (including SuSE) have started using ReiserFS as their default filesystem for Linux partitions.<br><br> + +<b>swap</b> The filesystem name is self-explanatory. The filesystem type "swap" is used in your swap partitions.<br><br> + +<b>vfat</b> and <b>ntfs</b> Your USB stick is most likely formatted as Vfat (more widely known as FAT32). Your Windows partitions are probably either Vfat or NTFS. The 9x series (95, 98, ME) all use Vfat, and the NT series (NT, 2000, XP, Vista, 7) use NTFS but they may be formatted as Vfat, too.<br><br> + +<b>auto</b> No, this isn't a filesystem type :-) The option "auto" simply means that the filesystem type is detected automatically. Sometimes the floppy and CD-ROM both have "auto" as their filesystem type. Why? Their filesystem type may vary. One floppy might be formatted for Windows and the other for Linux's Ext2. That's why it's wise to let the system automatically detect the filesystem type of media such as floppies and cdroms. +</html> |