diff --git a/doc/appendix.docbook b/doc/appendix.docbook deleted file mode 100644 index 5882aa3..0000000 --- a/doc/appendix.docbook +++ /dev/null @@ -1,156 +0,0 @@ - - Installation - - - How to obtain &partman; - - - The main website for &partman; is www.partitionmanager.org. For - the most current version, this is the place to go. - - - - - Requirements - - - In order to successfully use &partman;, you need &kde; 4.2 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. - - - - For a large part of its basic functionality &partman; relies on libparted. To generate UUIDs for copied file systems, it uses libuuid, which is part of e2fsprogs. It also uses the libblkid library from the util-linux-ng project to obtain information about partitions and file systems. All of these are required to build or run &partman;. - - - - &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 ntfsresize installed. None of these tools are required to build &partman; from sources. - - - - Here is a list of all external tools &partman; can make use of: - - - - - - &debugfsreiser4;: Reads usage information and file system labels for reiser4 file systems. Part of the reiser4progs utility suite that can be downloaded from . - - - - - - &debugreiserfs;: Reads usage information and file system labels for reiserfs file systems. Part of the reiserfsprogs utility suite that can be downloaded from . - - - - - - &dumpe2fs;: Reads usage information for ext2/ext3/ext4 file systems. Part of the e2fsprogs utility suite that can be downloaded from . - - - - - - &e2label;: Reads and writes file system labels for ext2/ext3/ext4 file systems. Part of the e2fsprogs utility suite that can be downloaded from . - - - - - - &fsckmsdos;: Reads usage information and checks FAT16 and FAT32 file systems. Part of the dosfstools utility suite that can be downloaded from . - - - - - - &hfsck;: Reads file system labels and checks HFS file systems. Part of the hfsutils utility suite that can be downloaded from . - - - - - - &hpfsck;: Checks HFS+ file systems. Part of the hfsplusutils utility suite that can be downloaded from . - - - - - - &jfsdebugfs;: Reads usage information for JFS file systems. Part of the jfsutils utility suite that can be downloaded from . - - - - - - &jfstune;: Reads and writes file system labels for JFS file systems. Part of the jfsutils utility suite that can be downloaded from . - - - - - - &ntfslabel;: Reads and writes file system labels for NTFS file systems. Part of the ntfsprogs utility suite that can be downloaded from . - - - - - - &ntfsresize;: Reads usage information, checks and resizes NTFS file systems. Part of the ntfsprogs utility suite that can be downloaded from . - - - - - - &swapoff;: Deactivates swap file systems. Part of the util-linux-ng utility suite that can be downloaded from . - - - - - - &swapon;: Activates swap file systems. Part of the util-linux-ng utility suite that can be downloaded from . - - - - - - &volid;: Reads file system labels for linuxswap file systems. Part of udev that can be downloaded from . - - - - - - &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 . - - - - - - - Compilation and Installation - &install.compile.documentation; - - - - Further Reading - - - - - The Linux Information Project has a ton of information on many aspects of Linux. Their article on partitions is very informative. But also see their entries on partition tables, hard disk devices and file systems. - - - - - - The Linux Partition HOWTO is a basic overview of handling and partitioning disk devices on Linux and the native Linux file systems. It also covers swap partitions. - - - - - - Wikipedia has an entry on disk partitioning. - - - - - - - - diff --git a/doc/faq.docbook b/doc/faq.docbook index 625b2fc..b4e6149 100644 --- a/doc/faq.docbook +++ b/doc/faq.docbook @@ -1,9 +1,6 @@ Questions and Answers - &reporting.bugs; - &updating.documentation; - diff --git a/doc/glossary.docbook b/doc/glossary.docbook index 7637d3e..c4cc4fd 100644 --- a/doc/glossary.docbook +++ b/doc/glossary.docbook @@ -102,6 +102,14 @@ + + GPT + + A modern partition table format supported by most modern computers and operating systems. It supports more than 4 primary partitions unlike older MS-DOS partition table. + + + + Head @@ -124,7 +132,7 @@ - + Label @@ -146,6 +154,26 @@ + + LUKS + + Linux Unified Key Setup is the standard encryption format for Linux. + + + + + + LVM + + LVM is a system for managing logical partitions that is more flexible than normal partitions. It consists of three main components: + + LVM physical volumes are partitions on the disk whose space is managed by LVM. + LVM volume group is a collection of LVM physical volumes that can be partitioned into logical partitions. It might be used to create file systems spanning over multiple devices or to split encrypted LUKS volume into smaller partitions. + LVM logical volumes are similar to normal partitions except that they reside on LVM volume group. Also, the location of LVM logical partitions does not matter and they do not have to be physically contiguous. Therefore, &partman; does not allow to move LVM logical volumes and displays the remaining free space at the end of the device. + + + + Operation diff --git a/doc/index.docbook b/doc/index.docbook index 79d7af6..fbfc427 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -2,7 +2,6 @@ KDE Partition Manager"> @@ -11,27 +10,8 @@ - - debugfs.reiser4"> - debugreiserfs"> - dumpe2fs"> - e2label"> - fsck.msdos"> - hfsck"> - hpfsck"> - jfs_debugfs"> - jfs_tune"> - ntfslabel"> - ntfsresize"> - swapoff"> - swapon"> - vol_id"> - xfs_db"> - - - ]> @@ -54,8 +34,8 @@ &FDLNotice; - 2010-01-08 - 1.00.00 + 2016-12-01 + &partman; 3.0.0 Manage your disks, partitions and file systems. @@ -82,8 +62,6 @@ &partman-faq; &partman-credits; - - &partman-appendix; &partman-glossary; diff --git a/doc/introduction.docbook b/doc/introduction.docbook index a0361b1..7d6ed13 100644 --- a/doc/introduction.docbook +++ b/doc/introduction.docbook @@ -8,7 +8,7 @@ - To get its job done efficiently &partman; makes use of external tools to support a long list of file systems. See for details about that. You will probably have the required tools for the file systems on your computer installed already. + To get its job done efficiently &partman; makes use of external tools to support a long list of file systems. You will probably have the required tools for the file systems on your computer installed already. diff --git a/doc/referencemanual.docbook b/doc/referencemanual.docbook index f427d7c..d2da79d 100644 --- a/doc/referencemanual.docbook +++ b/doc/referencemanual.docbook @@ -4,10 +4,9 @@ Overview This chapter gives detailed explanations of all commands available in &partman;. It is intended as a reference to accompany the information given in . - - - - The <guimenu>File</guimenu> Menu + + + The File Menu @@ -26,10 +25,10 @@ - + - - The <guimenu>Edit</guimenu> Menu + + The Edit Menu @@ -83,68 +82,118 @@ - + - - The <guimenu>View</guimenu> Menu + + The Device Menu - + - View - Devices + Device + Select Current Device + + + + Allows you to select a device from a submenu with all available devices of the system. + + + + + + + &Ctrl;&Shift;N + Device + New Partition Table - Toggles the Devices panel: This command turns the display of the devices list on and off. + Creates a new partition table: This command creates a new and empty GPT or 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. + + + This command is only enabled if a device is selected and no partition on this device + is currently mounted. - + - View - Pending Operations + Device + Export Partition Table - - Toggles the Pending Operations panel: This command turns the display of the operation list on and off. + Allows you to export a list of all partitions on the selected device into a file. - + - View - Information + Device + Import Partition Table - - Toggles the Information panel: 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. - + Allows you to import partition table from a previously exported file. + This will delete all partitions on the device and all data on them, + so you will want to be careful with this command. + This command is only enabled if a device is selected and no partition on this device is + currently mounted. Importing into logical devices such as LVM Volume Groups is currently not supported. - + - View - Log Output + Device + SMART Status - - Toggles the Log Output panel: This command turns the display of the log output panel on and off. - + Shows a SMART report. SMART is a monitoring system included in hard disk and solid-state drives + that detects and reports on various indicators of drive reliability, with the intent of enabling the + anticipation of hardware failures. - + - View + Device + Properties + + + + Shows information about currently selected devices. In this dialog you can find capacity, sector sizes, + partition table type as well as used and maximum number of primary partitions. + + + + + + + + The Tools Menu + + + + + + &Ctrl;&Shift;L + Tools + New Volume Group + + + + Create a new logical device such as LVM Volume Group. + + + + + + Tools File System Support @@ -169,16 +218,13 @@ If you have installed new tools while &partman; is running click on Rescan Support to force a recheck of installed file system support tools. - - Also see for which external tool is required for which operation. - - + F5 - View + Tools Refresh Devices @@ -190,36 +236,10 @@ - + - - The <guimenu>Device</guimenu> Menu - - - - - - &Ctrl;&Shift;N - Device - Create New Partition Table - - - - - Creates a new partition table: 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. - - - This command is only enabled if a device is selected and no partition on this device - is currently mounted. - - - - - - - - - The <guimenu>Partition</guimenu> Menu + + The Partition Menu @@ -253,7 +273,7 @@ - Resizes or moves a partition: 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 (shrinking it) or making it larger (growing it) -- may be available in this dialog. See . + Resizes or moves a partition: 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 (shrinking it) or making it larger (growing it) -- may be available in this dialog. See . 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. @@ -263,7 +283,7 @@ - Del + ∇ Partition Delete @@ -281,6 +301,27 @@ + + + + &Ctrl;∇ + Partition + Shred + + + + + Shreds a partition: This command shreds the currently selected partition. + + + This command is only enabled if a partition is selected that is not currently mounted. For an extended partition, it is only enabled if it does not contain any logical partitions. + + + Warning: Loss of data + Shreding a partition means that all data on the partition is destroyed. + + + @@ -338,6 +379,22 @@ + + + + Partition + Edit Mount Point + + + + + Opens a dialog to edit the mount point and the mount options. + + + This command is only enabled if a partition unmounted. + + + @@ -447,18 +504,20 @@ - + - - The <guimenu>Settings</guimenu> Menu + + The Settings and Help Menu - This is the common Settings menu present in most &kde; applications. Please see the &kde; documentation for details on this menu. + &partman; has the common &kde; Settings and + Help menu described in + the &kde; Fundamentals with an additional submenu Panels Shown, + where you can toggle the display of the Devices, + Pending Operations, Information + and panels Log Output on and off. + - - The <guimenu>Help</guimenu> Menu - &help.menu.documentation; - diff --git a/doc/usermanual.docbook b/doc/usermanual.docbook index ba93988..39b69e4 100644 --- a/doc/usermanual.docbook +++ b/doc/usermanual.docbook @@ -7,7 +7,7 @@ Besides the main view showing the currently selected device in a graphical and a tree view, &partman; uses &Qt;'s dock widgets or panels to display some information and allow selections. See the following screen shot for an overview of &partman;'s main window. - + &partman;'s main window @@ -25,10 +25,10 @@ - Toolbar: &partman;'s tool bar is a &kde; 4 standard tool bar. It can be fully customized; for details see . + Toolbar: &partman;'s tool bar is a standard tool bar. It can be fully customized; for details see . - + Devices Panel: This panel lists all devices 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. @@ -44,7 +44,7 @@ You can select a partition by clicking on it in the graphical device view. A double click opens the partition's properties dialog. A right click shows the partition context menu. - + 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 the partition's properties dialog. A right click shows the partition context menu.