Import documentation for partitionmanager

svn path=/trunk/playground/sysadmin/doc/partitionmanager/; revision=867075
This commit is contained in:
Volker Lanz 2008-10-02 18:31:29 +00:00
parent ee08938cea
commit acb8634d81
32 changed files with 1595 additions and 0 deletions

1
doc/CMakeLists.txt Normal file
View File

@ -0,0 +1 @@
kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)

156
doc/appendix.docbook Normal file
View File

@ -0,0 +1,156 @@
<appendix id="installation">
<title>Installation</title>
<sect1 id="obtaining">
<title>How to obtain &partman;</title>
<para>
The main website for &partman; is <ulink url="http://www.partitionmanager.org">www.partitionmanager.org</ulink>. For
the most current version, this is the place to go.
</para>
</sect1>
<sect1 id="requirements">
<title>Requirements</title>
<para>
In order to successfully use &partman;, you need &kde; 4.1 or later and &Qt; 4.4.0 or later. You do however not need to be logged into &kde; to use it: &partman; will run just fine under any other desktop environment as long as you have the basic &kde; libraries installed.
</para>
<para>
For a large part of its basic functionality &partman; relies on <ulink url="http://www.gnu.org/software/parted/index.shtml">libparted</ulink>. To generate UUIDs for copied file systems, it uses libuuid, which is part of <ulink url="http://sourceforge.net/projects/e2fsprogs">e2fsprogs</ulink>. Both of these are required to build or run &partman;.
</para>
<para>
&partman; makes extensive use of external tools to support a wide range of file systems. A specific tool is only required if you need the support for an operation it provides for a certain file system. For example, if you have no need to resize NTFS file systems you do not require to have <quote>ntfsresize</quote> installed. None of these tools are required to build &partman; from sources.
</para>
<para>
Here is a list of all external tools &partman; can make use of:
</para>
<itemizedlist>
<listitem>
<para>
&debugfsreiser4;: Reads usage information and file system labels for reiser4 file systems. Part of the reiser4progs utility suite that can be downloaded from <ulink url="http://www.kernel.org/pub/linux/utils/fs/reiser4/reiser4progs/"/>.
</para>
</listitem>
<listitem>
<para>
&debugreiserfs;: Reads usage information and file system labels for reiserfs file systems. Part of the reiserfsprogs utility suite that can be downloaded from <ulink url="http://www.kernel.org/pub/linux/utils/fs/reiserfs/"/>.
</para>
</listitem>
<listitem>
<para>
&dumpe2fs;: Reads usage information for ext2 and ext3 file systems. Part of the e2fsprogs utility suite that can be downloaded from <ulink url="http://e2fsprogs.sourceforge.net/"/>.
</para>
</listitem>
<listitem>
<para>
&e2label;: Reads and writes file system labels for ext2 and ext3 file systems. Part of the e2fsprogs utility suite that can be downloaded from <ulink url="http://e2fsprogs.sourceforge.net/"/>.
</para>
</listitem>
<listitem>
<para>
&fsckmsdos;: Reads usage information and checks FAT16 and FAT32 file systems. Part of the dosfstools utility suite that can be downloaded from <ulink url="ftp://ftp.uni-erlangen.de/pub/Linux/LOCAL/dosfstools/"/>.
</para>
</listitem>
<listitem>
<para>
&hfsck;: Reads file system labels and checks HFS file systems. Part of the hfsutils utility suite that can be downloaded from <ulink url="http://www.mars.org/home/rob/proj/hfs/"/>.
</para>
</listitem>
<listitem>
<para>
&hpfsck;: Checks HFS+ file systems. Part of the hfsplusutils utility suite that can be downloaded from <ulink url="http://www.penguinppc.org/historical/hfsplus/"/>.
</para>
</listitem>
<listitem>
<para>
&jfsdebugfs;: Reads usage information for JFS file systems. Part of the jfsutils utility suite that can be downloaded from <ulink url="http://jfs.sourceforge.net/"/>.
</para>
</listitem>
<listitem>
<para>
&jfstune;: Reads and writes file system labels for JFS file systems. Part of the jfsutils utility suite that can be downloaded from <ulink url="http://jfs.sourceforge.net/"/>.
</para>
</listitem>
<listitem>
<para>
&ntfslabel;: Reads and writes file system labels for NTFS file systems. Part of the ntfsprogs utility suite that can be downloaded from <ulink url="http://www.linux-ntfs.org/"/>.
</para>
</listitem>
<listitem>
<para>
&ntfsresize;: Reads usage information, checks and resizes NTFS file systems. Part of the ntfsprogs utility suite that can be downloaded from <ulink url="http://www.linux-ntfs.org/"/>.
</para>
</listitem>
<listitem>
<para>
&swapoff;: Deactivates swap file systems. Part of the util-linux utility suite that can be downloaded from <ulink url="ftp://ftp.us.kernel.org/pub/linux/utils/util-linux-ng/"/>.
</para>
</listitem>
<listitem>
<para>
&swapon;: Activates swap file systems. Part of the util-linux utility suite that can be downloaded from <ulink url="ftp://ftp.us.kernel.org/pub/linux/utils/util-linux-ng/"/>.
</para>
</listitem>
<listitem>
<para>
&volid;: Reads file system labels for linuxswap file systems. Part of udev that can be downloaded from <ulink url="http://www.us.kernel.org/pub/linux/utils/kernel/hotplug/"/>.
</para>
</listitem>
<listitem>
<para>
&xfsdb;: Reads usage information and reads and writes file system labels for XFS file systems. Part of the xfsprogs utility suite that can be downloaded from <ulink url="ftp://oss.sgi.com/projects/xfs/cmd_tars/"/>.
</para>
</listitem>
</itemizedlist>
</sect1>
<sect1 id="compilation">
<title>Compilation and Installation</title>
&install.compile.documentation;
</sect1>
<sect1 id="furtherreading">
<title>Further Reading</title>
<itemizedlist>
<listitem>
<para>
<ulink url="http://www.linfo.org/">The Linux Information Project</ulink> has a ton of information on many aspects of Linux. Their article on <ulink url="http://www.linfo.org/partition.html">partitions</ulink> is very informative. But also see their entries on <ulink url="http://www.linfo.org/partition_table.html">partition tables</ulink>, <ulink url="http://www.linfo.org/hdd.html">hard disk devices</ulink> and <ulink url="http://www.linfo.org/filesystem.html">file systems</ulink>.
</para>
</listitem>
<listitem>
<para>
The <ulink url="http://tldp.org/HOWTO/Partition/index.html">Linkux Partition HOWTO</ulink> is a basic overview of handling and partitioning disk devices on Linux and the native linux file systems. It also covers swap partitions.
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.wikipedia.org">Wikipedia</ulink> has an entry on <ulink url="http://en.wikipedia.org/wiki/Disk_partitioning">disk partitioning</ulink>.
</para>
</listitem>
</itemizedlist>
</sect1>
</appendix>

BIN
doc/copy_howto_1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

BIN
doc/copy_howto_2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

50
doc/copyhowto.docbook Normal file
View File

@ -0,0 +1,50 @@
<sect1 id="howto-copypartition">
<title>How-To: Copying a Partition</title>
<para>
This how-to describes copying a partition. We will assume the intention is to copy a partition from one device to another and overwriting an existing target partition, but the general procedure would not be much different when copying to the same device or to some unallocated area.
</para>
<para>
The following screenshot shows how the source device looks like:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="copy_howto_1.png" format="PNG"/></imageobject>
<textobject><phrase>Main window with source device</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
The source partition in our example will be <quote>sdb1</quote> which is currently mounted, indicated by the lock-icon next to the mount point name in the screen shot. A mounted partition can not be copied, thus you first need to unmount it: Click on it then select <xref linkend="menu-partition-mount"/>.
</para>
<para>
After unmounting the partition the lock icon has gone and it is now possible to select <xref linkend="menu-partition-copy"/>. This puts <quote>sdb1</quote> in &partman;'s clipboard; in other words: <quote>sdb1</quote> is now the partition that will be inserted when you select <xref linkend="menu-partition-paste"/>.
</para>
<para>
The destination device for copying in this how-to is <quote>/dev/sdc</quote>. Click on it in the Devices panel. This is how the device looks like before copying:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="copy_howto_2.png" format="PNG"/></imageobject>
<textobject><phrase>Main window with destination device before copying</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
The partition to overwrite is <quote>sdc5</quote>. To paste the copied partition into it, click on it and select <xref linkend="menu-partition-paste"/>. You will see the operation to copy the partition has been added to the list of pending operations. Note that there is no dialog box required to insert the partition as would be the case if you pasted into an unallocated area: Beginning and end of the pasted partition are determined by the overwritten partition.
</para>
<para>
Now select <xref linkend="menu-edit-apply"/> and the partition will be copied. See the <link linkend="howto-resizepartition">how-to on resizing partitions</link> for details about applying operations.
</para>
</sect1>

19
doc/credits.docbook Normal file
View File

@ -0,0 +1,19 @@
<chapter id="credits">
<title>Credits and License</title>
<para>
&partman;
</para>
<para>
Program copyright 2008 Volker Lanz
<email>vl@fidra.de</email>
</para>
<para>
Documentation Copyright &copy; 2008 Volker Lanz.
<email>vl@fidra.de</email>
</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;
</chapter>

151
doc/faq.docbook Normal file
View File

@ -0,0 +1,151 @@
<chapter id="faq">
<title>Questions and Answers</title>
&reporting.bugs;
&updating.documentation;
<qandaset id="faqlist">
<qandaentry>
<question>
<para>How dangerous is &partman; for my data?</para>
</question>
<answer>
<para>
First of all, you should never perform any destructive operations (delete, move, resize) without first making a complete backup of everything affected.
</para>
<para>
Having said that, &partman; is safe to use. It performs extensive checks before and after every operation. It calls external tools written and supported by the file system authors. And it has been tested extensively.
</para>
<para>
There is always the risk of data loss due to an unknown bug. &partman;'s authors try to minimize this risk, but there are of course no guarantees.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>I have installed all recommended external file system support packages and still do not get support for all operations on all file systems.</para>
</question>
<answer>
<para>
Not everything &partman; can do in principle can be done with all file systems.
</para>
<para>
One example is performing a file system check on linuxswap: It is just not possible. There are other limitations like that inherent in some file systems. You cannot shrink JFS or XFS file systems because neither of the two supports shrinking at all, with or without &partman;.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>Why can't I see any meaningful progress information when resizing a partition?</para>
</question>
<answer>
<para>
&partman; can only show progress information when it knows how long the jobs in an operation will take. Unfortunately this is usually not the case when resizing partitions because the by far longest job when doing so is resizing the file system on the partition. Resizing file systems is in most cases something an external tool will do on behalf of &partman; and these external tools do not provide useful progress information to &partman;, so there's nothing to report while they are running.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>Why can't I resize the root partition? How can I resize the partition /home is on?</para>
</question>
<answer>
<para>
To modifiy a partition it must not be mounted. You can however not unmount the root partition. Neither will you be able to unmount the home partition if the home directory of the currently logged in user is on it.
</para>
<para>
The solution for this problem is to boot from a Linux Live CD that comes with &partman; and modify these partitions from there.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>I'm getting a warning message in the log output about something that a partition cannot be created with the size I requested and that it will instead be smaller. What happened?</para>
</question>
<answer>
<para>
On MS-DOS partition tables, partitions have to begin and end on cylinder boundaries. This is mainly for historical reasons. &partman; will deal with this internally and try not to bother the user with that limitation.
</para>
<para>
Under rare circumstances, &partman; will however not be able to set up an operation in the way the user requested it due to this limitation. For example, if one cylinder on a device is 8 MiB large and you try to resize a partition by 6 MiB, this will not work.
</para>
<para>
You might also encounter this message if you have a device and partition table where the partitions are, for whatever reason, not correctly snapped to cylinder boundaries and you try to move or copy these partitions for the first time.
</para>
<para>
The message itself is harmless and only exists to inform the user that something can not be done quite exactly the way the user expects. Your partitions and data will not be negatively affected in any way if you see this message.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>How can I set a file system label when creating a new partition?</para>
</question>
<answer>
<para>
This cannot be done directly in the dialog to create the partition but you can easily <link linkend="menu-partition-properties">open the partition properties</link> for the new partition and set a file system label there.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>How many operations can I add to the list of pending operations?</para>
</question>
<answer>
<para>
There is no limit.
</para>
<para>
It is however not recommended to add too many operations to the list. There is always a small chance an operation might fail with an error, in which case &partman; will stop executing operations. In that case it is a lot easier to find out what happened (and to re-add all the operations that could not be executed) if the list of pending operations was not exceedingly long.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>Resizing an ext2 or ext3 file system failed with something in the report about <quote>no space left on device</quote>. What happened? Is my data corrupted now?</para>
</question>
<answer>
<para>
This is a problem of the <command>e2resize</command> command and the underlying ext2/3 file system. If a file system is nearly full, <command>e2resize</command> cannot make it any smaller even though that should be possible from the number of free sectors left. &partman; can unfortunately not know beforehand if <command>e2resize</command> will abort with this error for a given file system or not. If it happens nothing will be done at all and your data will not be negatively affected.
</para>
<para>
There is no real workaround for this problem right now.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>Why can't I format my floppy disk with &partman;? Why is there no support for CD writing or DVD burning?</para>
</question>
<answer>
<para>
None of this is what &partman; has been designed to do: It is an application that deals with partitions and the file systems on these partitions. Floppy disks, CDs or DVDs do not need or use partitions.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>Why can't I modify partitions on a device with an amiga or bsd partition table?</para>
</question>
<answer>
<para>
&partman; currently only allows read-only access to any other partition table type than MS-DOS. This is for safety reasons: Support in &partman; for this partition table types is not really there and what is there (or just incidentally works) has not been tested enough to use it with confidence.
</para>
<para>
Of course you can still create a new MS-DOS partition table on the device in question, but that is probably not what you want.
</para>
</answer>
</qandaentry>
<!--
<qandaentry>
<question>
<para></para>
</question>
<answer>
<para>
</para>
</answer>
</qandaentry>
-->
</qandaset>
</chapter>

BIN
doc/filesystemsupport.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

236
doc/glossary.docbook Normal file

File diff suppressed because one or more lines are too long

96
doc/index.docbook Normal file
View File

@ -0,0 +1,96 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY partman "<application>KDE Partition Manager</application>">
<!ENTITY partman-introduction SYSTEM "introduction.docbook">
<!ENTITY partman-usermanual SYSTEM "usermanual.docbook">
<!ENTITY partman-resizehowto SYSTEM "resizehowto.docbook">
<!ENTITY partman-copyhowto SYSTEM "copyhowto.docbook">
<!ENTITY partman-installoshowto SYSTEM "installoshowto.docbook">
<!ENTITY partman-referencemanual SYSTEM "referencemanual.docbook">
<!ENTITY partman-faq SYSTEM "faq.docbook">
<!ENTITY partman-credits SYSTEM "credits.docbook">
<!ENTITY partman-appendix SYSTEM "appendix.docbook">
<!ENTITY partman-glossary SYSTEM "glossary.docbook">
<!ENTITY debugfsreiser4 "<application>debugfs.reiser4</application>">
<!ENTITY debugreiserfs "<application>debugreiserfs</application>">
<!ENTITY dumpe2fs "<application>dumpe2fs</application>">
<!ENTITY e2label "<application>e2label</application>">
<!ENTITY fsckmsdos "<application>fsck.msdos</application>">
<!ENTITY hfsck "<application>hfsck</application>">
<!ENTITY hpfsck "<application>hpfsck</application>">
<!ENTITY jfsdebugfs "<application>jfs_debugfs</application>">
<!ENTITY jfstune "<application>jfs_tune</application>">
<!ENTITY ntfslabel "<application>ntfslabel</application>">
<!ENTITY ntfsresize "<application>ntfsresize</application>">
<!ENTITY swapoff "<application>swapoff</application>">
<!ENTITY swapon "<application>swapon</application>">
<!ENTITY volid "<application>vol_id</application>">
<!ENTITY xfsdb "<application>xfs_db</application>">
<!ENTITY kappname "&partman;">
<!ENTITY package "playground">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
]>
<book lang="&language;">
<bookinfo>
<title>The &partman; Handbook</title>
<authorgroup>
<author>
<firstname>Volker</firstname>
<surname>Lanz</surname>
</author>
</authorgroup>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
<copyright>
<year>2008</year>
<holder>Volker Lanz</holder>
</copyright>
<!-- Translators: put here the copyright notice of the translation -->
<legalnotice>&FDLNotice;</legalnotice>
<!-- Do NOT change these in the translation. -->
<date>2008-10-02</date>
<releaseinfo>0.80.00</releaseinfo>
<abstract>
<para>Manage your disks, partitions and file systems.</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>sysadmin</keyword>
<keyword>partition</keyword>
<keyword>manager</keyword>
<keyword>disk</keyword>
<keyword>device</keyword>
<keyword>filesystem</keyword>
</keywordset>
</bookinfo>
&partman-introduction;
&partman-usermanual;
&partman-referencemanual;
&partman-faq;
&partman-credits;
&partman-appendix;
&partman-glossary;
&documentation.index;
</book>

BIN
doc/installos_howto_1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

BIN
doc/installos_howto_2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

BIN
doc/installos_howto_3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

BIN
doc/installos_howto_4.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

BIN
doc/installos_howto_5.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

BIN
doc/installos_howto_6.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

BIN
doc/installos_howto_7.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

131
doc/installoshowto.docbook Normal file
View File

@ -0,0 +1,131 @@
<sect1 id="howto-installos">
<title>How-To: Installing a New Operating System</title>
<para>
This how-to describes the preparation of a new hard disk device for an OS installation: Suppose you bought a new hard disk and now intend to use it as a replacement for the old one that currently holds your OS and data partitions. You would also like to take this oppurtunity to install a new operation system. Several steps will have to be taken to make the transition from the old to the new system and drive.
</para>
<para>
In the following, <quote>/dev/sdb</quote> is the old hard disk and <quote>/dev/sdc</quote> is the new one. This screenshot shows the situation on the source device:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="installos_howto_1.png" format="PNG"/></imageobject>
<textobject><phrase>Main window with source device</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
The new device will look like this. Note that it doesn't yet have valid partition table, thus the first step to take is to create one by selecting <xref linkend="menu-device-createpartitiontable"/>:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="installos_howto_2.png" format="PNG"/></imageobject>
<textobject><phrase>Main window with destination device</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
After confirming the warning dialog you can begin creating partitions on the new device by clicking the extended partition and selecting <xref linkend="menu-partition-new"/>. Begin with an extended partition at the end of the device to later hold the home and swap partitions:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="installos_howto_3.png" format="PNG"/></imageobject>
<textobject><phrase>Creating an extended partition</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
Click <guibutton>OK</guibutton> and the operation to create this extended partition is added to the list.
</para>
<para>
Now create a primary partition on the rest of the device where the new OS will be installed. Make it as large as the unallocated area in front of the extended partition:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="installos_howto_4.png" format="PNG"/></imageobject>
<textobject><phrase>Creating a primary partition</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
Click <guibutton>OK</guibutton> in the dialog to accept your choice. The operation to create the new primary partition is then added to the operation list.
</para>
<para>
Now it is time to copy the home partition from the old device to the extended partition on the new device. Select the old device in the Device List panel, click on partition <quote>sdb5</quote> and pick <xref linkend="menu-partition-copy"/>.
</para>
<para>
Then go back to the new device and click the extended partition. Select <xref linkend="menu-partition-paste"/>. The following dialog will come up:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="installos_howto_5.png" format="PNG"/></imageobject>
<textobject><phrase>Pasting the home partition</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
This already looks mostly okay but you already know that you will not need that much free space after the home partition because you will later create a swap partition there. And a swap partition of more than 3 GiB is a little large.
</para>
<para>
So grab the right resize handle in the dialog's resizer widget and move it to the right until the free space after the pasted partition is only about 1.5 GiB in size:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="installos_howto_6.png" format="PNG"/></imageobject>
<textobject><phrase>Resizing a pasted partition</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
This looks fine. Click <guibutton>OK</guibutton> to accept and close the dialog. A new operation to paste the copied partition to the extended partition on <quote>sdc</quote> is added to the operation list. Note that this operation will also set the new size.
</para>
<para>
Finally you will want to create a new swap partition at the end of the extended partition on <quote>sdc</quote>. There is no need to copy the existing swap partition from <quote>sdb</quote> because swap does not hold any permanent information worth keeping. Simply create a new partition with type linuxswap that fills the whole of the unallocated area after the new home partition.
</para>
<para>
The main window with all operations and the preview of how <quote>sdc</quote> will look like once they are applied now looks like this:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="installos_howto_7.png" format="PNG"/></imageobject>
<textobject><phrase>Main window after setting up all operations</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
This looks great so select <xref linkend="menu-edit-apply"/>, confirm the warning dialog and wait until the operations have all been executed. For details on executing operations see <link linkend="howto-resizepartition">the how-to on resizing partitions</link>.
</para>
<para>
Your new hard disk device is now ready for the installation of your new operation system.
</para>
</sect1>

31
doc/introduction.docbook Normal file
View File

@ -0,0 +1,31 @@
<chapter id="introduction">
<title>Introduction</title>
<para>
&partman; is a utility program to help you manage the <glossterm linkend="glossary-device">disk devices</glossterm>, <glossterm linkend="glossary-partition">partitions</glossterm> and <glossterm linkend="glossary-filesystem">file systems</glossterm> on your computer.
</para>
<para>
It allows you to easily <link linkend="howto-installos">create new partitions</link>, create file systems on new or existing partitions, <link linkend="howto-copypartition">copy</link>, move or delete partitions and also to <link linkend="howto-resizepartition">modify a partition's size</link> without losing the data on it.
</para>
<para>
To get its job done efficiently &partman; makes use of external tools to support a long list of file systems. See <xref linkend="requirements"/> for details about that. You will probably have the required tools for the file systems on your computer installed already.
</para>
<warning>
<title>Always back up your data!</title>
<para>
&partman; has been designed and written with high diligence and an emphasis on data integrity. There is however always some danger involved when modifying a device's partition table or its partitions: There might still be a bug in &partman;, an unexpected power failure or a problem with the computer's hardware.
</para>
<para>
For those reasons you should <emphasis>always have a back up of your important data</emphasis> before making any modifications with a tool like &partman;.
</para>
<para>
The program's authors take no responsibility whatsoever if you lose any data while using &partman;.
</para>
</warning>
<para>
&partman; uses <glossterm linkend="glossary-operation">operations</glossterm>, <glossterm linkend="glossary-job">jobs</glossterm> and <glossterm linkend="glossary-command">commands</glossterm> to logically divide up the work it does. See the <link linkend="glossary">glossary</link> for details on this.
</para>
</chapter>

BIN
doc/mainwindow.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 113 KiB

463
doc/referencemanual.docbook Normal file
View File

@ -0,0 +1,463 @@
<chapter id="reference">
<title>Command Reference</title>
<sect1 id="reference-overview">
<title>Overwiew</title>
<para>This chapter gives detailed explanations of all commands available in &partman;. It is intended as a reference to accompany the information given in <xref linkend="usermanual"/>.</para>
</sect1>
<sect1 id="menu-file">
<title>The <guimenu>File</guimenu> Menu</title>
<para>
<variablelist>
<varlistentry id="menu-file-quit">
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></shortcut>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Quits &partman;</action> without applying any pending operations. The application will however ask you to confirm your choice to quit if there are pending operations.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>
<sect1 id="menu-edit">
<title>The <guimenu>Edit</guimenu> Menu</title>
<para>
<variablelist>
<varlistentry id="menu-edit-undo">
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Undo</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Undoes the last operation</action> that has been added to the operation stack.
</para>
<para>
This command is only enabled if the list of operations is not empty.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-edit-clear">
<term>
<menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Clear</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Clears the list of operations</action> without applying any of them.
</para>
<para>
This command is only enabled if the list of operations is not empty.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-edit-apply">
<term>
<menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Apply</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Applies the list of operations</action>. This command will apply all operations in the list so that all changes are permanently written to your disks. After the operations have been applied, the list is cleared and there will be no way to undo any operation.
</para>
<para>
This command is only enabled if the list of operations is not empty.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>
<sect1 id="menu-view">
<title>The <guimenu>View</guimenu> Menu</title>
<para>
<variablelist>
<varlistentry id="menu-view-devices">
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Devices</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Toggles the Devices panel</action>: This command turns the display of the devices list on and off.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-view-operations">
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Pending Operations</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Toggles the Pending Operations panel</action>: This command turns the display of the operation list on and off.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-view-information">
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Information</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Toggles the Information panel</action>: This command turns the display of the information panel on and off. The information panel will either display details about the currently selected device or, if one is selected, the selected partition.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-view-log">
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Log Output</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Toggles the Log Output panel</action>: This command turns the display of the log output panel on and off.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-view-filesystemsupport">
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>File System Support</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Shows the file system support dialog.</action> This dialog shows in detail which operations can be performed for which of the supported file systems.
</para>
<para>
Here is an example how the dialog might look like with most external tools installed:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="filesystemsupport.png" format="PNG"/></imageobject>
<textobject><phrase>File system support dialog with most external tools installed</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
The blue check marks mean <quote>supported</quote>, the red crosses mean <quote>not supported</quote>. Some combinations are never supported, for example checking a linuxswap file system, because they are inherently impossible. Others cannot be supported because the external tools lack the functionality. This is for instance the case with reading or writing labels for FAT file systems.
</para>
<para>
If you have installed new tools while &partman; is running click on <guibutton>Rescan Support</guibutton> to force a recheck of installed file system support tools.
</para>
<para>
Also see <xref linkend="requirements"/> for which external tool is required for which operation.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-view-refresh">
<term>
<menuchoice>
<shortcut><keycap>F5</keycap></shortcut>
<guimenu>View</guimenu>
<guimenuitem>Refresh Devices</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Refreshes the devices</action>: This command forces &partman; to scan and read the devices on your computer again. This may for example be useful if you plugged in an external USB hard disk after you started &partman;.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>
<sect1 id="menu-device">
<title>The <guimenu>Device</guimenu> Menu</title>
<para>
<variablelist>
<varlistentry id="menu-device-createpartitiontable">
<term>
<menuchoice>
<guimenu>Device</guimenu>
<guimenuitem>Create New Partition Table</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Creates a new partition table</action>: This command creates a new and empty MSDOS partition table on the currently selected device. This will delete all partitions on the device and all data on them, so you will want to be careful with this command.
</para>
<para>
This command is only enabled if a device is selected and no partition on this device
is currently mounted.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>
<sect1 id="menu-partition">
<title>The <guimenu>Partition</guimenu> Menu</title>
<para>
<variablelist>
<varlistentry id="menu-partition-new">
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut>
<guimenu>Partition</guimenu>
<guimenuitem>New</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Creates a new partition</action>: Opens the dialog to create a new partition where you will be able to set type, size, position and file system of the partition to create.
</para>
<para>
Please note that the partition table on a device may impose restrictions on how many partitions can be created. MS-DOS partition tables, for example, allow only four primary partitions.
</para>
<para>
This command is only enabled if an unallocated area on a device is selected.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-partition-resize">
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo></shortcut>
<guimenu>Partition</guimenu>
<guimenuitem>Resize/Move</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Resizes or moves a partition</action>: Opens the dialog to resize or move an existing partition. Depending on the partition's file system and the external tools installed on your computer, not all three possible resize-related actions -- that is, moving the partition, making it smaller (<quote>shrinking</quote> it) or making it larger (<quote>growing</quote> it) -- may be available in this dialog. See <xref linkend="menu-view-filesystemsupport"/>.
</para>
<para>
This command is only enabled if a partition is selected that is not currently mounted and whose file system can be shrunk, grown or moved. For an extended partition, it is only enabled if none of the logicals in the extended partition are mounted.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-partition-delete">
<term>
<menuchoice>
<shortcut><keycap>Del</keycap></shortcut>
<guimenu>Partition</guimenu>
<guimenuitem>Delete</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Deletes a partition</action>: This command deletes the currently selected partition.
</para>
<para>
This command is only enabled if a partition is selected that is not currently mounted. For an extended partition, it is only enabled if none of the logicals in the extended partition are mounted.
</para>
<warning>
<title>Warning: Possible loss of data</title>
<para>Deleting a partition means that all data on the partition is destroyed.</para>
</warning>
</listitem>
</varlistentry>
<varlistentry id="menu-partition-copy">
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo></shortcut>
<guimenu>Partition</guimenu>
<guimenuitem>Copy</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Copies a partition</action>: This command copies the currently selected partition to &partman;'s clipboard.
</para>
<para>
This command is only enabled if a partition is selected that is not currently mounted and whose file system can be copied. Extended partitions can not be copied.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-partition-paste">
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo></shortcut>
<guimenu>Partition</guimenu>
<guimenuitem>Paste</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Paste a partition</action>: This command pastes the partition from &partman;'s clipboard to the currently selected partition or unallocated area.
</para>
<para>
When pasting to an unallocated area, a dialog will open allowing you to move or grow the inserted copy. When overwriting an existing partition this dialog will not be shown.
</para>
<para>
This command is only enabled if a partition is currently in the clipboard and a valid target (either a partition or an unallocated area) is selected. The target must also be large enough to hold the source and can not be mounted. You can not copy a partition onto itself.
</para>
<warning>
<title>Warning: Possible loss of data</title>
<para>Pasting a partition on an existing one means that all data on the existing partition is destroyed and replaced with the data from the pasted partition.</para>
</warning>
</listitem>
</varlistentry>
<varlistentry id="menu-partition-mount">
<term>
<menuchoice>
<guimenu>Partition</guimenu>
<guimenuitem>Mount/Unmount</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Mounts or umounts a partition</action>: This command mounts or unmounts the selected partition, depending on its current state.
</para>
<para>
This command is only enabled if a partition is selected that can be mounted or unmounted. If the operating system does not know a mount point for the partition you can not mount it from &partman;.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-partition-check">
<term>
<menuchoice>
<guimenu>Partition</guimenu>
<guimenuitem>Check</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Checks a partition</action>: This command checks the selected partition and its file system for errors and tries to correct any problems it finds. During this process the file system on the partition will also be resized to fill the partition completely.
</para>
<para>
This command is only enabled if a partition is selected that can be checked and is not currently mounted.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-partition-backup">
<term>
<menuchoice>
<guimenu>Partition</guimenu>
<guimenuitem>Backup</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Backs up a partition</action>: This command backs up the file system on the selected partition to a file. You will be asked where to store the image file after activating this command.
</para>
<para>
The created image file is a sector-for-sector copy of the file system on the partition. It is not compressed and does not have any additional meta information or header added to it, thus it can be directly mounted using a loop device outside of &partman; if the operation system supports that.
</para>
<para>
This command is only enabled if a partition is selected and the file system on it can be backed up. The partition must also not be mounted.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-partition-restore">
<term>
<menuchoice>
<guimenu>Partition</guimenu>
<guimenuitem>Restore</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Restores a partition</action>: This command restores a file system from an image file to a partition. You will be asked for the name of the image file to restore after activating this command. The target to restore to must be large enough for the image file.
</para>
<para>
The command is only enabled if either an unallocated area is selected or a partition that is not currently mounted.
</para>
<warning>
<title>Warning: Possible loss of data</title>
<para>Restoring a partition on an existing one means that all data on the existing partition is destroyed and replaced with the data from the restored image file.</para>
</warning>
</listitem>
</varlistentry>
<varlistentry id="menu-partition-properties">
<term>
<menuchoice>
<guimenu>Partition</guimenu>
<guimenuitem>Properties</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Shows a partition's properties</action>: This command shows a dialog with information about the currently selected partition or unallocated space.
</para>
<para>
What is displayed and what can be modified in this dialog depends on the type of partition, the type of the file system on the partition and on the partition being currently mounted or not.
</para>
<para>
Not all file systems, for example, support setting a label (and while the FAT file systems do, &partman; currently has no support for setting the label on FAT file systems). It is also generally not possible to modify any properties if the partition is mounted.
</para>
<para>
This is a list of all partition and file system properties that can in general be modified in this dialog:
<itemizedlist>
<listitem>
<para>Set or modify a file system's label</para>
</listitem>
<listitem>
<para>Change the partition's file system.</para>
<warning>
<title>Warning: Possible loss of data</title>
<para>Changing the file system for a partition always means that all data on the partition is destroyed.</para>
</warning>
</listitem>
<listitem>
<para>Recreate the file system on the partition</para>
<warning>
<title>Warning: Possible loss of data</title>
<para>Recreating a file system on a partition always means that all data on the partition is destroyed. Recreating a file system should only be used as a last ressort if the file system on a partition cannot be repaired anymore.</para>
</warning>
</listitem>
<listitem>
<para>Change a partition's flags</para>
<para>Depenging on the type of partition table used, there will be several flags available for each partition on the partition table. In most cases, modifying the flags is not necessary and should be considered an advanced feature.</para>
</listitem>
</itemizedlist>
</para>
<para>
The command is only enabled if either an unallocated area or a partition is selected.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>
<sect1 id="menu-settings">
<title>The <guimenu>Settings</guimenu> Menu</title>
<para>
This is the common <guimenu>Settings</guimenu> menu present in most &kde; applications. Please see the &kde; documentation for details on this menu.
</para>
</sect1>
<sect1>
<title>The <guimenu>Help</guimenu> Menu</title>
&help.menu.documentation;
</sect1>
</chapter>

BIN
doc/resize_howto_1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

BIN
doc/resize_howto_2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

BIN
doc/resize_howto_3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

BIN
doc/resize_howto_4.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

BIN
doc/resize_howto_5.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

BIN
doc/resize_howto_6.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

BIN
doc/resize_howto_7.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

BIN
doc/resize_howto_8.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

BIN
doc/resize_howto_9.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 100 KiB

172
doc/resizehowto.docbook Normal file
View File

@ -0,0 +1,172 @@
<sect1 id="howto-resizepartition">
<title>How-To: Resizing a Partition</title>
<para>
This how-to explains the resizing of a <glossterm linkend="glossary-partition">partition</glossterm> that is becoming too full. See the following screenshot for the initial situation before resizing:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="resize_howto_1.png" format="PNG"/></imageobject>
<textobject><phrase>Main window before resizing partitions</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
On <glossterm linkend="glossary-device">device</glossterm> <quote>/dev/sdb</quote>, partition <quote>sdb2</quote> has only little free space left while the other partition, <quote>sdb1</quote>, is far from being full. For that reason it seems advisable to make the first partition a little smaller and grow <quote>sdb2</quote> so it has more free space available.
</para>
<note>
<title>Note: You cannot modify mounted partitions.</title>
<para>In the screenshot above both partitions are not currently mounted. If one or both of them were mounted you would have to unmount them first using <xref linkend="menu-partition-mount"/>.</para>
</note>
<para>
The first step is to make more room for the partition to grow, so start by shrinking <quote>sdb1</quote> from its current size of 7.21 GiB to a more fittingly 5.00 GiB. Click on the partition and choose <xref linkend="menu-partition-resize"/>. The following dialog comes up:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="resize_howto_2.png" format="PNG"/></imageobject>
<textobject><phrase>Resize dialog before resizing /dev/sdb1</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
The dialog allows you to resize the partition in multiple ways. You can either drag the right handle to the left until the partition has the desired size or simply enter the size in the <guilabel>Size</guilabel> text field. Another possibility would be to adjust the size by clicking on the little arrows next to the text field, but that is a little tedious for larger changes.
</para>
<para>
Whichever way you prefer for setting the new size, the dialog should now look like this:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="resize_howto_3.png" format="PNG"/></imageobject>
<textobject><phrase>Resize dialog after resizing /dev/sdb1</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
After you click on <guibutton>OK</guibutton>, a new operation is added to the pending operations list and the graphical view and tree view of the device are updated to reflect the new situation:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="resize_howto_4.png" format="PNG"/></imageobject>
<textobject><phrase>Main window after resizing /dev/sdb1</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<note>
<title>Note: Operations are previewed first before applying them.</title>
<para>Although the main window reflects the device's state how it will be after applying the new operation, the operation has in fact not been applied yet: While operations are pending you can still undo them (one by one using <xref linkend="menu-edit-undo"/> or <xref linkend="menu-edit-clear"/> to undo all of them) or quit &partman;, and nothing will have been modified at all.</para>
</note>
<para>
Now that there is some free space between the two partitions you can move and grow partition <quote>sdb2</quote>. First, click on <quote>sdb2</quote> and choose <xref linkend="menu-partition-resize"/> again. The resize dialog comes up once more, this time for the second partition. Drag its left handle to the leftmost end so that the dialog looks like this:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="resize_howto_5.png" format="PNG"/></imageobject>
<textobject><phrase>Resize dialog after resizing /dev/sdb2</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
Be careful to make sure that the <guilabel>Free space before</guilabel> text field really does show <quote>0 MiB</quote> because otherwise there will be a little free space left between the partitions that will then be wasted.
</para>
<para>
Now click <guibutton>OK</guibutton> again. In the main window things now look like this:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="resize_howto_6.png" format="PNG"/></imageobject>
<textobject><phrase>Main window after resizing /dev/sdb2</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
This already looks like what you wanted, so choose <xref linkend="menu-edit-apply"/>. A dialog box will come up and ask you if you are sure to apply the pending operations. Confirm this dialog box and &partman; will begin executing operations:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="resize_howto_7.png" format="PNG"/></imageobject>
<textobject><phrase>&partman; is applying operations</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
While operations are being executed you can click on the plus-sign next to each operation in the list to find out the jobs it is made up of and see which job is currently being run.
</para>
<para>
Resizing a partition in the way you resized <quote>/dev/sdb2</quote> above always means it has to be moved to the left first before it can be grown because partitions can never be grown to the left directly. Unfortunately, moving such a large partition will take quite some time. It is not unusual for an operation like this to take several minutes or even more.
</para>
<para>
Finally, all operations will have been successfully completed:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="resize_howto_8.png" format="PNG"/></imageobject>
<textobject><phrase>Progress dialog after successfully applying operations</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
By clicking on <guibutton>OK</guibutton> you can now close the progress dialog and return to the main window. &partman; will rescan your devices at this point so that might take a few seconds.
</para>
<para>
If you are interested in some more details about the operations that were just run click on <guibutton>Details</guibutton>. You will see the detailed report that is always generated (and updated on the fly) while &partman; executes operations:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="resize_howto_9.png" format="PNG"/></imageobject>
<textobject><phrase>Progress dialog details</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
This report is particularly of interest if an error occurs while executing operations. A report shows each operation, each job and each external command that is being run and is thus very helpful when trying to track down problems.
</para>
<para>
You can save the report as <acronym>HTML</acronym> or view it in an external web browser.
</para>
<tip>
<para>
Always save the detailed report as <acronym>HTML</acronym> when executing the operations fails with errors or warnings for later reference. You might also want to include it in a bug report you submit to &partman;'s authors.
</para>
</tip>
<para>
To hide the details again click on <guibutton>Details</guibutton> and to finally close the progress dialog click on <guibutton>OK</guibutton>.
</para>
</sect1>

89
doc/usermanual.docbook Normal file
View File

@ -0,0 +1,89 @@
<chapter id="usermanual">
<title>Using &partman;</title>
<sect1 id="mainwindow">
<title>The Main Window</title>
<para>
Besides the main view showing the currently selected device in a graphical and a tree view, &partman; uses &Qt;'s <quote>dock widgets</quote> or panels to display some information and allow selections. See the following screen shot for an overview of &partman;'s main window.
</para>
<para>
<screenshot>
<screeninfo>&partman;'s main window</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="mainwindow.png" format="PNG"/></imageobject>
<textobject><phrase>Main Window</phrase></textobject>
</mediaobject>
</screenshot>
</para>
<para>
<itemizedlist>
<listitem>
<para>Menubar: The menu bar presents some custom and some non-standard menus to choose actions to perform. All commands are described in detail in <xref linkend="reference"/>.</para>
</listitem>
<listitem>
<para>Toolbar: &partman;'s tool bar is a &kde; 4 standard tool bar. It can be fully customized; for details see <xref linkend="menu-settings"/>.
</para>
</listitem>
<listitem>
<para>Devices Panel: This panel lists all <glossterm linkend="glossary-device">devices</glossterm> found on your computer that &partman; can handle. Select a device in this panel to view or modify it in the graphical device view or in the tree device view.</para>
</listitem>
<listitem>
<para>
Graphical Device View: In this view &partman; shows a graphical representation of the currently selected device. Each of the device's <glossterm linkend="glossary-partition">partitions</glossterm> has its own box with device node name (<quote>sda1</quote> for the first partition in the screenshot above) and usage information (the dark violet area and <quote>7.61 GiB</quote> in the screenshot).
</para>
<para>
<glossterm linkend="glossary-extendedpartition">Extended partitions</glossterm> are visually distinct by their extra border (light green in the screenshot above) around them.
</para>
<para>
You can select a partition by clicking on it in the graphical device view. A double click opens <link linkend="menu-partition-properties">the partition's properties dialog</link>. A right click shows the partition context menu.
</para>
</listitem>
<listitem>
<para>
Tree Device View: The tree device view shows extended information about each partition on the selected device. The currently selected partition is highlighted. Double-clicking a partition opens <link linkend="menu-partition-properties">the partition's properties dialog</link>. A right click shows the partition context menu.
</para>
</listitem>
<listitem>
<para>Information Panel: The information panel shows some details about the currently selected device or partition. It is not enabled by default.</para>
</listitem>
<listitem>
<para>
Pending Operations Panel: This panel lists all operations that will be executed once you choose <xref linkend="menu-edit-apply"/>.
</para>
<para>
In the screenshot above, one operation is pending: If the user applies the operations now, the ext2 <glossterm linkend="glossary-filesystem">file system</glossterm> on /dev/sdb7 (which is 1.99 GiB in size) will be checked for errors and, if required, repaired.
</para>
</listitem>
<listitem>
<para>
Statusbar: The status bar shows how many operations are currently pending.
</para>
</listitem>
<listitem>
<para>Log Output Panel: This panel shows log information. It is only of secondary importance for non-advanced users and is not enabled by default.</para>
</listitem>
</itemizedlist>
</para>
</sect1>
&partman-resizehowto;
&partman-copyhowto;
&partman-installoshowto;
</chapter>