gparted/README

GPARTED
=======
Gparted is the Gnome Partition Editor for creating, reorganizing, and
deleting disk partitions.

A hard disk is usually subdivided into one or more partitions.  These
partitions are normally not re-sizable (making one smaller and the
adjacent one larger.)  Gparted makes it possible for you to take a
hard disk and change the partition organization, while preserving the
partition contents.

More specifically, Gparted enables you to create, destroy, resize,
move, check, label, and copy partitions, and the file systems
contained within.  This is useful for creating space for new operating
systems, reorganizing disk usage, and mirroring one partition with
another (disk imaging).

Gparted can also be used with storage devices other than hard disks,
such as USB flash drives, and memory cards.

Visit http://gparted.org for more information.


LICENSING
---------
GParted is released under the General Public License version 2, or (at
your option) any later version.  (GPLv2+).  All files are released under
the GPLv2+ unless explicitly licensed otherwise.

The GParted Manual is released under the GNU Free Documentation License
version 1.2 or any later version.  (GFDLv1.2+).

See these files for more details:
   COPYING      - GNU General Public License version 2
   COPYING-DOCS - GNU Free Documentation License version 1.2


NEWS
----
Information about changes to this release, and past releases can be
found in the file:
   NEWS


INSTALL
-------
a. Pre-built Binary

   Many GNU/Linux distributions already provide a pre-built binary
   package for GParted.  Instructions on how to install GParted on
   some distributions is given below:

      Debian or Ubuntu
      ----------------
      sudo apt-get install gparted

      Fedora or CentOS/RHEL
      ---------------------
      su -
      yum install gparted

      OpenSUSE
      --------
      sudo zypper install gparted

b. Building from Source

   Building Gparted from source requires that several dependencies are
   installed.  These include:
      g++
      e2fsprogs
      parted
      gtkmm24
      gettext
      gnome-doc-utils     - required if help documentation is to be built

   On Debian or Ubuntu, these dependencies may be obtained by running
   one of the following commands:
     Either;
      sudo apt-get build-dep gparted
     Or;
      sudo apt-get install build-essential e2fsprogs uuid uuid-dev \
                           gnome-common libparted-dev libgtkmm-2.4-dev \
                           libdevmapper-dev gnome-doc-utils docbook-xml

   On Fedora, you will need to run (as root);
      yum install gtkmm24-devel parted-devel e2fsprogs-devel gettext \
                  'perl(XML::Parser)' desktop-file-utils libuuid-devel \
                  gnome-doc-utils docbook-dtds rarian-compat intltool \
                  gcc-g++
      yum groupinstall 'Development Tools'

   On openSUSE, these dependencies may be obtained by running the
   following commands;
      sudo zypper install automake autoconf make gnome-common \
                          libuuid-devel parted-devel gtkmm2-devel \
                          gnome-doc-utils-devel docbook-xsl-stylesheets
      sudo zypper install -t pattern devel_c_c++

   Briefly, the shell commands `./configure; make; make install' should
   configure, build, and install this package.

   If you wish to build this package without the help documentation use
   the --disable-doc flag:
      E.g., ./configure --disable-doc

   If you wish to build this package for use on a desktop that does not
   support scrollkeeper use the --disable-scrollkeeper flag:
      E.g., ./configure --disable-scrollkeeper

   If you wish to build this package to use native libparted /dev/mapper
   dmraid support use the --enable-libparted-dmraid flag:
      E.g., ./configure --enable-libparted-dmraid

   If you wish to build this package with online resize support then
   the following is required:
      a)  A version of libparted that includes the online resize patch.
          At time of writing (November 2013), this patch was only
          included in Debian and derived distros with parted package
          version 2.3-14 or higher.
      b)  Linux kernel version 3.6 or higher.
   Enable with the --enable-online-resize flag:
      E.g., ./configure --enable-online-resize

   Please note that more than one configure flag can be used:
      E.g., ./configure --disable-doc --enable-libparted-dmraid

   The INSTALL file contains further GNU installation instructions.


DIRECTORIES
------------
compose  - contains String::ucompose() function

data     - contains desktop icons

doc      - contains manual page documentation

help     - contains GParted Manual and international translations

include  - contains source header files

m4       - contains macro files

po       - contains international language translations

src      - contains C++ source code


DISTRIBUTION NOTES
------------------
Gparted uses GNU libparted to detect and manipulate devices and partition
tables.  Several optional packages provide additional file system support.
Optional packages include:

   btrfs-tools
   e2fsprogs
   f2fs-tools
   dosfstools
   mtools          - required to read and write FAT16/32 volume labels and UUIDs
   hfsutils
   hfsprogs
   jfsutils
   nilfs-utils
   ntfsprogs / ntfs-3g
   reiser4progs
   reiserfsprogs
   xfsprogs, xfsdump

   NOTE:  * If the vol_id command is in the search PATH, it will be used
            to read linux-swap, reiser4, hfs, and hfs+ file system
            volume labels.
          * If the blkid command is in the search path, it will be used
            to read file system UUIDs and labels.  It is also used for
            ext4 file system detection.
            blkid is part of the util-linux package and e2fsprogs
            package before that.


For dmraid support, the following packages are required:

   dmsetup         - removes /dev/mapper entries
   dmraid          - lists dmraid devices and creates /dev/mapper entries

For GNU/Linux distribution dmraid support, the following are required:
   - kernel built with Device Mapping and Mirroring built.  From menuconfig,
     it is under Device Drivers -> <something> (RAID & LVM).
   - dmraid drive arrays activated on boot (e.g., dmraid -ay).


For LVM2 Physical Volume support the following command is required:
   lvm             - LVM2 administration tool
And device-mapper support in the kernel.


For attempt data rescue for lost partitions, the following package
is required:
   gpart           - guesses PC-type hard disk partitions


Several more commands are optionally used by GParted if found on the system.
These commands include:

   blkid         - used to read volume labels and detect ext4 file systems
   vol_id        - used to read volume labels
   udisks        - used to prevent automounting of file systems
   devkit-disks  - used to prevent automounting of file systems
   {filemanager} - used in attempt data rescue to display discovered
                   file systems.  (e.g., nautilus, pcmanfm)
   hal-lock      - used to prevent automounting of file systems
   gksudo        - used to acquire root privileges in .desktop file,
                   but only if available when gparted source is configured.
   gksu          - alternatively used to acquire root privileges in .desktop
                   file if gksu not available, but only if available when
                   gparted source is configured.
   kdesudo       - alternatively used to acquire root privileges in .desktop
                   file if gksudo and gksu not available, but only if available
                   when gparted source is configured.
   xdg-su        - alternatively used to acquire root privileges in .desktop
                   file if gksudo, gksu, and kdesudo are not available, but only
                   if available when gparted source is configured.
   udevinfo      - used in dmraid to query udev name
   udevadm       - used in dmraid to query udev name
   yelp          - used to display help manual