Fixed some command line examples by adding the replaceable tag. Lachlan diff --git a/XFS_User_Guide/en-US/XFS-mkfs.xml b/XFS_User_Guide/en-US/XFS-mkfs.xml index 17e8d67..eb29d72 100644 --- a/XFS_User_Guide/en-US/XFS-mkfs.xml +++ b/XFS_User_Guide/en-US/XFS-mkfs.xml @@ -25,7 +25,7 @@ <para>The default value is 4KB, the minimum is 512 bytes, and the maximum is 64KB</para> <para>XFS on Linux currently only supports pagesize or smaller blocks.</para> <para>To create a filesystem with a block size of 2048 bytes you would use:</para> - <para><command>mkfs.xfs -b size=2048 device</command></para> + <para><command>mkfs.xfs -b size=2048 <replaceable>device</replaceable> </command></para> <para><emphasis>Smaller block sizes reduce wasted space for lots of small files.</emphasis></para> </section> <section> @@ -33,9 +33,9 @@ <para>An XFS filesystem is divided into allocation groups</para> <para>More allocation groups offer more parallelism when allocating blocks and inodes</para> <para>To create filesystem with 16 allocation groups you would use</para> - <para><command>mkfs.xfs -d acount=16 device</command></para> + <para><command>mkfs.xfs -d acount=16 <replaceable>device</replaceable></command></para> <para>To create a filesystem with a specific size for the allocation groups</para> - <para><command>mkfs.xfs -d agsize=4g device</command></para> + <para><command>mkfs.xfs -d agsize=4g <replaceable>device</replaceable></command></para> <para><emphasis>Filesystems with too few or too many allocation groups should be avoided.</emphasis></para> </section> <section> @@ -47,9 +47,9 @@ and one I/O to the other three, taking longer than it should.</para></listitem> </itemizedlist> <para>To create a filesystem with a stripe unit of 1MB for an 8+1 RAID you would use:</para> - <para><command>mkfs.xfs -d sunit=2048,swidth=16384 device</command></para> + <para><command>mkfs.xfs -d sunit=2048,swidth=16384 <replaceable>device</replaceable></command></para> <para>or</para> - <para><command>mkfs.xfs -d su=1m,sw=8m device</command></para> + <para><command>mkfs.xfs -d su=1m,sw=8m <replaceable>device</replaceable></command></para> <note><para>xfsprogs 3.1.0 and newer will use the blkid library to correctly identify stripe geometry for lvm, md, and some hardware raid devices which export this information</para></note> @@ -69,7 +69,7 @@ <listitem><para>how much data may be associated with the inode before data goes out of line</para></listitem> </itemizedlist> <para>To allocate 512 bytes to each inode:</para> - <para><command>mkfs.xfs -i size=512 device</command></para> + <para><command>mkfs.xfs -i size=512 <replaceable>device</replaceable></command></para> </section> <section> <title>mkfs - Extended Attributes</title> @@ -80,7 +80,7 @@ <listitem><para>Version 1 inodes are automatically converted to version 2 on the fly</para></listitem> </itemizedlist> <para>To force the use of version two extended attributes you would use:</para> - <para><command>mkfs.xfs -i attr=2 device</command></para> + <para><command>mkfs.xfs -i attr=2 <replaceable>device</replaceable></command></para> </section> <section> <title>mkfs - Naming options</title> @@ -92,9 +92,9 @@ <listitem><para>XFS on Linux does not support naming (directory) version 1.</para></listitem> </itemizedlist> <para>To create a filesystem with a directory block size of 16KB you would use:</para> - <para><command>mkfs.xfs -n size=16384 device</command></para> + <para><command>mkfs.xfs -n size=16384 <replaceable>device</replaceable></command></para> <para>ASCII-only case-insensitive naming:</para> - <para><command>mkfs.xfs -n version=ci device</command></para> + <para><command>mkfs.xfs -n version=ci <replaceable>device</replaceable></command></para> </section> <section> <title>mkfs - External Log</title> @@ -108,8 +108,8 @@ <itemizedlist> <listitem><para>15K RPM disk or battery-backed memory</para></listitem> </itemizedlist> - <para><command>mkfs.xfs -l logdev=log_device device</command></para> - <para><command>mount -o logdev=log_device device path</command></para> + <para><command>mkfs.xfs -l logdev=<replaceable>log_device</replaceable> <replaceable>device</replaceable></command></para> + <para><command>mount -o logdev=<replaceable>log_device</replaceable> <replaceable>device</replaceable> <replaceable>path</replaceable></command></para> </section> <section> <title>mkfs - Realtime</title> @@ -121,8 +121,8 @@ <itemizedlist> <listitem><para>Bitmap allocator only has to manage file data allocations</para></listitem> </itemizedlist> - <para><command>mkfs.xfs -l logdev=log_device -r rtdev=rt_device device</command></para> - <para><command>mount -o logdev=log_device,rtdev=rt_device device path</command></para> + <para><command>mkfs.xfs -l logdev=<replaceable>log_device</replaceable> -r rtdev=<replaceable>rt_device</replaceable> <replaceable>device</replaceable></command></para> + <para><command>mount -o logdev=<replaceable>log_device</replaceable>,rtdev=<replaceable>rt_device</replaceable> <replaceable>device</replaceable> <replaceable>path</replaceable></command></para> <para><emphasis>rt_device</emphasis> is the device for the file data, device is for the metadata</para> <para>Receives limited testing and support in Linux</para> <note><para>Filesystems created with a realtime subvolume can only be mounted on kernels @@ -132,7 +132,7 @@ <title>mkfs - Filesystem Image</title> <para>mkfs allows you to create a filesystem as a regular file</para> <para>This can be used to create a filesystem on a loop-back device</para> - <para><command>mkfs.xfs -d file=1,name=filename,size=2g filename</command></para> + <para><command>mkfs.xfs -d file=1,name=<replaceable>filename</replaceable>,size=2g <replaceable>filename</replaceable></command></para> </section> <section> <title>mkfs - Sector Size</title> @@ -140,7 +140,7 @@ <para>Default value is 512 bytes.</para> <para>The minimum value for sector size is 512; the maximum is 32768 (32 KB) or the filesystem block size (whichever is smaller).</para> <para>To create a filesystem on a device that has a sector size of 1KB you would use:</para> - <para><command>mkfs.xfs -s size=1024 device</command></para> + <para><command>mkfs.xfs -s size=1024 <replaceable>device</replaceable></command></para> <note><para>xfsprogs 3.1.0 and newer will automatically detect the appropriate sector size for a device</para></note> </section> <section> @@ -148,7 +148,7 @@ <para>Set the filesystem label.</para> <para>XFS filesystem labels can be at most 12 characters long.</para> <para>To create a filesystem and specify the label you would use:</para> - <para><command>mkfs.xfs -L label device</command></para> + <para><command>mkfs.xfs -L <replaceable>label</replaceable> <replaceable>device</replaceable></command></para> <note><para>A label may later be added or changed by using the <command>xfs_admin</command> command</para></note> </section> <section> diff --git a/XFS_User_Guide/en-US/XFS-mount.xml b/XFS_User_Guide/en-US/XFS-mount.xml index 75b36b4..817a2da 100644 --- a/XFS_User_Guide/en-US/XFS-mount.xml +++ b/XFS_User_Guide/en-US/XFS-mount.xml @@ -25,9 +25,9 @@ <section> <title>Mount Options - Log & Realtime Devices</title> <para>Use an external log (metadata journal) device:</para> - <para><command>mount -o logdev=log_device device mountpoint</command></para> + <para><command>mount -o logdev=<replaceable>log_device</replaceable> <replaceable>device</replaceable> <replaceable>mountpoint</replaceable></command></para> <para>Use an external log (metadata journal) and real-time device:</para> - <para><command>mount -o logdev=log_device,rtdev=rt_device device mountpoint</command></para> + <para><command>mount -o logdev=<replaceable>log_device</replaceable>,rtdev=<replaceable>rt_device</replaceable> <replaceable>device</replaceable> <replaceable>mountpoint</replaceable></command></para> </section> <section> <title>Mount Options - 32 or 64 bit Inodes</title> @@ -64,7 +64,7 @@ <para>Specify the stripe unit and width for a RAID device or a stripe volume.</para> <para>Values must be specified in 512-byte block units.</para> <para>For example, to use a stripe unit of 1MB and a stripe width of 8MB:</para> - <para><command>mount -o sunit=2048,swidth=16384 device mountpoint</command></para> + <para><command>mount -o sunit=2048,swidth=16384 <replaceable>device</replaceable> <replaceable>mountpoint</replaceable></command></para> <para><command>swalloc</command> mount option</para> <itemizedlist> <listitem><para>data allocations will be rounded up to stripe width boundaries when the @@ -120,7 +120,7 @@ </itemizedlist> <para>When the new form is used for the first time (by setting or removing extended attributes) the on-disk superblock feature bit field will be updated to reflect this format being in use.</para> - <para><command>mount -o attr2 device mountpoint</command></para> + <para><command>mount -o attr2 <replaceable>device</replaceable> <replaceable>mountpoint</replaceable></command></para> </section> <section> <title>Mount Options - Group Ids</title> @@ -142,7 +142,7 @@ <para>If the filesystem was not cleanly unmounted, it is likely to be inconsistent when mounted in <command>norecovery</command> mode. Some files or directories may not be accessible because of this.</para> <para>Filesystems mounted <command>norecovery</command> must be mounted read-only or the mount will fail.</para> - <para><command>mount -o ro,norecovery device mountpoint</command></para> + <para><command>mount -o ro,norecovery <replaceable>device</replaceable> <replaceable>mountpoint</replaceable></command></para> </section> <section> <title>Mount Options - Barriers</title> @@ -174,11 +174,11 @@ <section> <title>Mount Options - User/Group/Project Quotas</title> <para>User disk quota accounting enabled, and limits (optionally) enforced.</para> - <para><command>mount -o uquota device mountpoint</command></para> + <para><command>mount -o uquota <replaceable>device</replaceable> <replaceable>mountpoint</replaceable></command></para> <para>Group disk quota accounting enabled, and limits (optionally) enforced.</para> - <para><command>mount -o grpquota device mountpoint</command></para> + <para><command>mount -o grpquota <replaceable>device</replaceable> <replaceable>mountpoint</replaceable></command></para> <para>Project quota accounting enabled, and limits (optionally) enforced.</para> - <para><command>mount -o prjquota device mountpoint</command></para> + <para><command>mount -o prjquota <replaceable>device</replaceable> <replaceable>mountpoint</replaceable></command></para> <para>Can optionally specify <command>uqnoenforce</command>, <command>gqnoenforce</command> and <command>pqnoenforce</command> to use soft limits.</para> _______________________________________________ xfs mailing list xfs@xxxxxxxxxxx http://oss.sgi.com/mailman/listinfo/xfs
