update partitionsmanager docbooks to kf5

bump fate + release info
proofread/update
remove unused entities
remove appendix.docbook
REVIEW:129597
This commit is contained in:
Burkhard Lück 2016-12-03 21:26:22 +01:00
parent fda44206f3
commit f33ba21736
7 changed files with 172 additions and 266 deletions

File diff suppressed because one or more lines are too long

View File

@ -1,9 +1,6 @@
<chapter id="faq">
<title>Questions and Answers</title>
&reporting.bugs;
&updating.documentation;
<qandaset id="faqlist">
<qandaentry>
<question>

View File

@ -102,6 +102,14 @@
<glosssee otherterm="glossary-partitionflag"/>
</glossentry>
<glossentry>
<glossterm>GPT</glossterm>
<glossdef>
<para>A modern partition table format supported by most modern computers and operating systems. It supports more than 4 <link linkend="glossary-primarypartition">primary partitions</link> unlike older MS-DOS partition table.
</para>
</glossdef>
</glossentry>
<glossentry id="glossary-head">
<glossterm>Head</glossterm>
<glossdef>
@ -124,7 +132,7 @@
</glossdef>
</glossentry>
<glossentry>
<glossentry id="glossary-label">
<glossterm>Label</glossterm>
<glossdef>
<para>
@ -146,6 +154,26 @@
</glossdef>
</glossentry>
<glossentry id="glossary-luks">
<glossterm>LUKS</glossterm>
<glossdef>
<para>Linux Unified Key Setup is the standard encryption format for Linux.
</para>
</glossdef>
</glossentry>
<glossentry id="glossary-lvm">
<glossterm>LVM</glossterm>
<glossdef>
<para>LVM is a system for managing logical partitions that is more flexible than normal partitions. It consists of three main components:</para>
<simplelist>
<member>LVM physical volumes are partitions on the disk whose space is managed by LVM.</member>
<member>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 <link linkend="glossary-luks">LUKS</link> volume into smaller partitions.</member>
<member>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.</member>
</simplelist>
</glossdef>
</glossentry>
<glossentry id="glossary-operation">
<glossterm>Operation</glossterm>
<glossdef>

View File

@ -2,7 +2,6 @@
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
<!ENTITY partman "<application>KDE Partition Manager</application>"> <!--remove this entity later, it is also in lang/user.entities to make it translatable-->
<!ENTITY partman-introduction SYSTEM "introduction.docbook">
<!ENTITY partman-usermanual SYSTEM "usermanual.docbook">
<!ENTITY partman-resizehowto SYSTEM "resizehowto.docbook">
@ -11,27 +10,8 @@
<!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 "extragear">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
]>
@ -54,8 +34,8 @@
<legalnotice>&FDLNotice;</legalnotice>
<date>2010-01-08</date>
<releaseinfo>1.00.00</releaseinfo>
<date>2016-12-01</date>
<releaseinfo>&partman; 3.0.0</releaseinfo>
<abstract>
<para>Manage your disks, partitions and file systems.</para>
@ -82,8 +62,6 @@
&partman-faq;
&partman-credits;
&partman-appendix;
&partman-glossary;

View File

@ -8,7 +8,7 @@
</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.
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.
</para>
<warning>

View File

@ -4,10 +4,9 @@
<sect1 id="reference-overview">
<title>Overview</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>
<sect2 id="menu-file">
<title>The File Menu</title>
<para>
<variablelist>
<varlistentry id="menu-file-quit">
@ -26,10 +25,10 @@
</varlistentry>
</variablelist>
</para>
</sect1>
</sect2>
<sect1 id="menu-edit">
<title>The <guimenu>Edit</guimenu> Menu</title>
<sect2 id="menu-edit">
<title>The Edit Menu</title>
<para>
<variablelist>
<varlistentry id="menu-edit-undo">
@ -83,68 +82,118 @@
</varlistentry>
</variablelist>
</para>
</sect1>
</sect2>
<sect1 id="menu-view">
<title>The <guimenu>View</guimenu> Menu</title>
<sect2 id="menu-device">
<title>The Device Menu</title>
<para>
<variablelist>
<varlistentry id="menu-view-devices">
<varlistentry id="menu-device-selectcurrentdevice">
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Devices</guimenuitem>
<guimenu>Device</guimenu>
<guimenuitem>Select Current Device</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>Allows you to select a device from a submenu with all available devices of the system.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-device-createpartitiontable">
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>N</keycap></keycombo></shortcut>
<guimenu>Device</guimenu>
<guimenuitem>New Partition Table</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Toggles the Devices panel</action>: This command turns the display of the devices list on and off.
<action>Creates a new partition table</action>: 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.
</para>
<para>
This command is only enabled if a device is selected and no partition on this device
is currently mounted.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-view-operations">
<varlistentry id="menu-device-exportpartitiontable">
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Pending Operations</guimenuitem>
<guimenu>Device</guimenu>
<guimenuitem>Export Partition Table</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>Allows you to export a list of all partitions on the selected device into a file.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-view-information">
<varlistentry id="menu-device-importpartitiontable">
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Information</guimenuitem>
<guimenu>Device</guimenu>
<guimenuitem>Import Partition Table</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>
<para>Allows you to import partition table from a previously exported file.</para>
<para>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. Importing into logical devices such as LVM Volume Groups is currently not supported.</para>
</listitem>
</varlistentry>
<varlistentry id="menu-view-log">
<varlistentry id="menu-device-smartstatus">
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Log Output</guimenuitem>
<guimenu>Device</guimenu>
<guimenuitem>SMART Status</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>
<para>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.</para>
</listitem>
</varlistentry>
<varlistentry id="menu-view-filesystemsupport">
<varlistentry id="menu-device-properties">
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenu>Device</guimenu>
<guimenuitem>Properties</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>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.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect2>
<sect2 id="menu-tools">
<title>The Tools Menu</title>
<para>
<variablelist>
<varlistentry id="menu-tools-volumegroup">
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>L</keycap></keycombo></shortcut>
<guimenu>Tools</guimenu>
<guimenuitem>New Volume Group</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>Create a new logical device such as <link linkend="glossary-lvm">LVM</link> Volume Group.</para>
</listitem>
</varlistentry>
<varlistentry id="menu-tools-filesystemsupport">
<term>
<menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>File System Support</guimenuitem>
</menuchoice>
</term>
@ -169,16 +218,13 @@
<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">
<varlistentry id="menu-tools-refresh">
<term>
<menuchoice>
<shortcut><keycap>F5</keycap></shortcut>
<guimenu>View</guimenu>
<guimenu>Tools</guimenu>
<guimenuitem>Refresh Devices</guimenuitem>
</menuchoice>
</term>
@ -190,36 +236,10 @@
</varlistentry>
</variablelist>
</para>
</sect1>
</sect2>
<sect1 id="menu-device">
<title>The <guimenu>Device</guimenu> Menu</title>
<para>
<variablelist>
<varlistentry id="menu-device-createpartitiontable">
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>N</keycap></keycombo></shortcut>
<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>
<sect2 id="menu-partition">
<title>The Partition Menu</title>
<para>
<variablelist>
@ -253,7 +273,7 @@
</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"/>.
<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-tools-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.
@ -263,7 +283,7 @@
<varlistentry id="menu-partition-delete">
<term>
<menuchoice>
<shortcut><keycap>Del</keycap></shortcut>
<shortcut>&Del;</shortcut>
<guimenu>Partition</guimenu>
<guimenuitem>Delete</guimenuitem>
</menuchoice>
@ -281,6 +301,27 @@
</warning>
</listitem>
</varlistentry>
<varlistentry id="menu-partition-shred">
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;&Del;</keycombo></shortcut>
<guimenu>Partition</guimenu>
<guimenuitem>Shred</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Shreds a partition</action>: This command shreds 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 it does not contain any logical partitions.
</para>
<warning>
<title>Warning: Loss of data</title>
<para>Shreding a partition means that all data on the partition is destroyed.</para>
</warning>
</listitem>
</varlistentry>
<varlistentry id="menu-partition-copy">
<term>
<menuchoice>
@ -338,6 +379,22 @@
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-partition-edit-mount">
<term>
<menuchoice>
<guimenu>Partition</guimenu>
<guimenuitem>Edit Mount Point</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Opens a dialog</action> to edit the mount point and the mount options.
</para>
<para>
This command is only enabled if a partition unmounted.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu-partition-check">
<term>
<menuchoice>
@ -447,18 +504,20 @@
</varlistentry>
</variablelist>
</para>
</sect1>
</sect2>
<sect1 id="menu-settings">
<title>The <guimenu>Settings</guimenu> Menu</title>
<sect2 id="menu-settings-help">
<title>The Settings and Help 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.
&partman; has the common &kde; <ulink url="help:/fundamentals/ui.html#menus-settings">Settings</ulink> and
<ulink url="help:/fundamentals/ui.html#menus-help">Help</ulink> menu described in
the &kde; Fundamentals with an additional submenu <guisubmenu>Panels Shown</guisubmenu>,
where you can toggle the display of the <guimenuitem>Devices</guimenuitem>,
<guimenuitem>Pending Operations</guimenuitem>, <guimenuitem>Information</guimenuitem>
and panels <guimenuitem>Log Output</guimenuitem> on and off.
</para>
</sect2>
</sect1>
<sect1 id="menu-help">
<title>The <guimenu>Help</guimenu> Menu</title>
&help.menu.documentation;
</sect1>
</chapter>

View File

@ -7,7 +7,7 @@
<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>
@ -25,10 +25,10 @@
</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>Toolbar: &partman;'s tool bar is a standard tool bar. It can be fully customized; for details see <xref linkend="menu-settings-help"/>.
</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>
@ -44,7 +44,7 @@
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.