doc: add @dircategory to Info documentation

[android-x86/external-parted.git] / doc / parted.texi

diff --git a/doc/parted.texi b/doc/parted.texi
index 936a1f6..885f312 100644 (file)
--- a/doc/parted.texi
+++ b/doc/parted.texi
@@ -14,10 +14,10 @@ resizing, checking and copy partitions and file systems on them.
 @ifnottex @c texi2pdf don't understand copying and insertcopying ???
 @c modifications must also be done in the titlepage
 @copying
-Copyright @copyright{} 1999-2009 Free Software Foundation, Inc.
+Copyright @copyright{} 1999-2010 Free Software Foundation, Inc.
 
 Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1 or
+under the terms of the GNU Free Documentation License, Version 1.3 or
 any later version published by the Free Software Foundation; with no
 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
 Texts.  A copy of the license is included in the section entitled ``GNU
@@ -29,6 +29,7 @@ Free Documentation License''.
 @end ifplaintext
 @end ifnottex
 
+@dircategory System administration
 @direntry
 * parted: (parted).                         GNU partitioning software
 @end direntry
@@ -48,7 +49,7 @@ Free Documentation License''.
 Copyright @copyright{} 1999-2009 Free Software Foundation, Inc.
 
 Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1 or
+under the terms of the GNU Free Documentation License, Version 1.3 or
 any later version published by the Free Software Foundation; with no
 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
 Texts.  A copy of the license is included in the section entitled ``GNU
@@ -83,9 +84,7 @@ edited by Leslie P. Polzer in 2006.
 * Related information::         Further reading on related topics
 * Copying This Manual::         How to make copies of this manual
 * History::                     This manual's history
-@ifnotplaintext
-* Index::                       Index of referenced concepts
-@end ifnotplaintext
+* Concept index::               Concept index
 @end menu
 
 @node    Introduction
@@ -496,6 +495,11 @@ display a help message
 @itemx --script
 never prompt the user
 
+@item -a alignment-type
+@itemx --align alignment-type
+Set alignment for newly created partitions, valid alignment types are:
+none, cylinder, minimal and optimal.
+
 @item -v
 @itemx --version
 display the version
@@ -510,6 +514,7 @@ display the version
 GNU Parted provides the following commands:
 
 @menu
+* align-check::
 * check::
 * cp::
 * help::
@@ -529,6 +534,33 @@ GNU Parted provides the following commands:
 * unit::
 @end menu
 
+@node align-check
+@subsection align-check
+@cindex align-check, command description
+@cindex command description, align-check
+
+@deffn Command align-check @var{align-type} @var{n}
+
+Determine whether the starting sector of partition @var{n}
+meets the disk's selected alignment criteria.
+@var{align-type} must be @samp{minimal}, @samp{optimal}
+or an abbreviation.
+When in script mode, if the partition does not meet the alignment
+requirement, exit with status 1;  otherwise (including on older
+kernels for which alignment data is not available), continue processing
+any remaining commands.
+Without @option{--script}, print either @samp{@var{N} aligned}
+or @samp{@var{N} not aligned}.
+
+Example:
+
+@example
+(parted) @kbd{align-check minimal 1}
+1 aligned
+@end example
+
+@end deffn
+
 @node check
 @subsection check
 @cindex check, command description
@@ -673,7 +705,7 @@ Make a @var{fat32} file system on partition 2.
 @cindex mkpart, command description
 @cindex command description, mkpart
 
-@deffn Command mkpart @var{part-type} [@var{fs-type}] @var{start} @var{end}
+@deffn Command mkpart [@var{part-type} @var{fs-type} @var{name}] @var{start} @var{end}
 
 Creates a new partition, @emph{without} creating a new file system on
 that partition.  This is useful for creating partitions for file systems
@@ -684,10 +716,13 @@ partitions (i.e., non-extended partitions).  @var{start} and @var{end}
 are the offset from the beginning of the disk, that is, the ``distance''
 from the start of the disk.
 
-@var{part-type} is one of: primary, extended, logical.  Extended and
-logical are only used for msdos and dvh disk labels.
+@var{part-type} is one of @samp{primary}, @samp{extended} or @samp{logical},
+and may be specified only with @samp{msdos} or @samp{dvh} partition tables.
+A @var{name} must be specified for a @samp{gpt} partition table.
+Neither @var{part-type} nor @var{name} may be used with a @samp{sun}
+partition table.
 
-@var{fs-type} must be on of these supported file systems:
+@var{fs-type} must be one of these supported file systems:
 @itemize @bullet
 @item ext2
 @item fat16, fat32
@@ -1009,6 +1044,11 @@ either ``on'' or ``off''.  Some or all of these flags will be available,
 depending on what disk label you are using:
 
 @table @samp
+
+@item bios_grub
+(GPT) - Enable this to record that the selected partition is a
+GRUB BIOS partition.
+
 @item boot
 (Mac, MS-DOS, PC98) - should be enabled if you want to boot off the
 partition.  The semantics vary between disk labels.  For MS-DOS disk
@@ -1219,12 +1259,9 @@ by the Free Software Foundation; with no Invariant Sections, with no
 Front-Cover Texts, and with no Back-Cover Texts.  @xref{Copying
 This Manual}, for details.
 
-@c FIXME: why doesn't this @ifnotplaintext work?!
-@c @ifnotplaintext
-@node Index
+@node Concept index
 @unnumbered Index
 @printindex cp
-@c @end ifnotplaintext
 
 @bye