BwackNinja/spacefm - Githubissues

README for SpaceFM v0.9.4

Homepage: http://ignorantguru.github.io/spacefm/

Downloads: http://sourceforge.net/projects/spacefm/files/ https://github.com/IgnorantGuru/spacefm/tree/pkg

Official Forum: https://sourceforge.net/p/spacefm/discussion/general/

Guidelines For Distributing Modifications: https://github.com/IgnorantGuru/spacefm/wiki/Guidelines-For-Distributing-Modifications

CONTENTS

DESCRIPTION
PACKAGES
INSTALLER
BUILD GTK2
BUILD GTK3
BUILD HAL
BUILD NEXT
BUILD DEBUG
CREATE DEB PACKAGE
UNINSTALL
ENABLE KERNEL POLLING
TRANSLATE
LICENSE

DESCRIPTION

SpaceFM is a multi-panel tabbed file manager with built-in VFS, udev-based
device manager, customizable menu system, and bash integration.

PACKAGES

Find or add packages, forum threads, and other info for your distro:
    https://github.com/IgnorantGuru/spacefm/wiki/Distros

For other distros:
    See INSTALLER below

NOTE: Enabling kernel polling is recommended after installing SpaceFM.  See
      the ENABLE KERNEL POLLING section below or visit:
http://ignorantguru.github.io/spacefm/spacefm-manual-en.html#devices-kernpoll

INSTALLER

A self-extracting installer is available (spacefm-x.x.x-installer.sh):
    https://github.com/IgnorantGuru/spacefm/tree/pkg
        (To save a file, click on its filename and click 'View Raw')

The installer requires the build dependencies listed below in BUILD.  If
any dependencies are missing, examine the error, install missing packages,
and try again.

The installer MUST be run in a terminal.  It automatically builds and
installs.  Run it like this:

    bash spacefm-x.x.x-installer.sh

or to see options:

    bash spacefm-x.x.x-installer.sh --help

To reinstall or upgrade, just run the latest installer again.

NOTE: Enabling kernel polling is recommended after installing SpaceFM:
http://ignorantguru.github.io/spacefm/spacefm-manual-en.html#devices-kernpoll

BUILD GTK2

1) Install required build dependencies (below are Debian package names - packages names on your distro may vary but should be similar):

    autotools-dev bash build-essential desktop-file-utils libc6 libcairo2
    libglib2.0-0 libglib2.0-dev libgtk2.0-0 (>=2.18) libgtk2.0-dev
    libgtk2.0-bin libpango1.0-0 libx11-6 shared-mime-info intltool
    pkg-config fakeroot libudev0 (>=143) libudev-dev

Also Recommended: udevil|pmount|udisks eject lsof wget ktsuss|gksu|kdesu
                  libstartup-notification0 libstartup-notification0-dev
                  dbus libdbus-1-3 libdbus-1-dev

configure will report anything missing when you run it as shown below.

2) Use these commands to download the SpaceFM tarball and build:

    # Download & Extract
    mkdir /tmp/spacefm-build && cd /tmp/spacefm-build
    wget -O spacefm.tar.gz https://github.com/IgnorantGuru/spacefm/tarball/master
    tar xzf spacefm.tar.gz
    cd IgnorantGuru-spacefm-*

    # Build & Install
    ./configure
    make -s
    sudo make install
    sudo update-mime-database /usr/local/share/mime > /dev/null
    sudo update-desktop-database -q
    sudo gtk-update-icon-cache -q -t -f /usr/local/share/icons/hicolor
    sudo gtk-update-icon-cache -q -t -f /usr/local/share/icons/Faenza

    # Remove Temporary Files
    cd / && rm -rf /tmp/spacefm-build

NOTES:
a) If configure reports missing dependencies, install them and run
   configure again before proceeding to make.

b) Enabling kernel polling is recommended after installing SpaceFM:
   http://ignorantguru.github.io/spacefm/spacefm-manual-en.html#devices-kernpoll

c) SpaceFM supports ktsuss, gksu, gksudo, gnomesu, kdesu, and xdg-su.
   To build with an additional custom su program ('/usr/bin/mysu' in this
   example), add:
      --with-preferable-sudo=/usr/bin/mysu   # to the configure command

BUILD GTK3

The GTK3 build of SpaceFM uses the newer GTK libraries. BE SURE to use a GTK3 theme which supports your CURRENT version of GTK3 (no theme warnings should appear when spacefm is run in a terminal), or use adwaita. Use of GTK3 without any theme is NOT recommended.

PACKAGERS: Due to the unfinished and changing nature of GTK3, some users may prefer the GTK2 build. Please consider providing both spacefm-gtk2 and spacefm-gtk3 packages for your users.

1) Install required build dependencies (below are Debian package names - packages names on your distro may vary but should be similar):

    autotools-dev bash build-essential desktop-file-utils libc6 libcairo2
    libglib2.0-0 libglib2.0-dev libgtk-3-0 libgtk-3-dev libgtk-3-bin
    libpango1.0-0 libx11-6 shared-mime-info intltool pkg-config fakeroot
    libudev0 (>=143) libudev-dev

Also Recommended: udevil|pmount|udisks eject lsof wget ktsuss|gksu|kdesu
                  libstartup-notification0 libstartup-notification0-dev
                  dbus libdbus-1-3 libdbus-1-dev

configure will report anything missing when you run it as shown below.

2) Use these commands to download the SpaceFM tarball and build:

    # Download & Extract
    mkdir /tmp/spacefm-build && cd /tmp/spacefm-build
    wget -O spacefm.tar.gz https://github.com/IgnorantGuru/spacefm/tarball/master
    tar xzf spacefm.tar.gz
    cd IgnorantGuru-spacefm-*

    # Build & Install
    ./configure --with-gtk3
    make -s
    sudo make install
    sudo update-mime-database /usr/local/share/mime > /dev/null
    sudo update-desktop-database -q
    sudo gtk-update-icon-cache -q -t -f /usr/local/share/icons/hicolor
    sudo gtk-update-icon-cache -q -t -f /usr/local/share/icons/Faenza

    # Remove Temporary Files
    cd / && rm -rf /tmp/spacefm-build

NOTES:
a) If configure reports missing dependencies, install them and run
   configure again before proceeding to make.

b) Enabling kernel polling is recommended after installing SpaceFM:
   http://ignorantguru.github.io/spacefm/spacefm-manual-en.html#devices-kernpoll

c) SpaceFM supports ktsuss, gksu, gksudo, gnomesu, kdesu, and xdg-su.
   To build with an additional custom su program ('/usr/bin/mysu' in this
   example), add:
      --with-preferable-sudo=/usr/bin/mysu   # to the configure command

BUILD HAL

Device features are extremely limited with HAL. Use of this build is only recommended if udev is not installed. SpaceFM HAL support is no longer actively developed, yet please report any build problems.

1) Install required build dependencies (below are Debian package names - packages names on your distro may vary but should be similar):

    autotools-dev bash build-essential desktop-file-utils libc6 libcairo2
    libglib2.0-0 libglib2.0-dev libgtk2.0-0 (>=2.18) libgtk2.0-dev
    libgtk2.0-bin libpango1.0-0 libx11-6 shared-mime-info intltool
    pkg-config fakeroot
    hal libhal-dev libhal-storage-dev libhal-storage1 libhal1
    dbus libdbus-1-3 libdbus-1-dev libdbus-glib-1-2 libdbus-glib-1-dev

Also Recommended: wget ktsuss|gksu libstartup-notification0
                  libstartup-notification0-dev

configure will report anything missing when you run it as shown below.

2) Use these commands to download the SpaceFM tarball and build:

    # Download & Extract
    mkdir /tmp/spacefm-build && cd /tmp/spacefm-build
    wget -O spacefm.tar.gz https://github.com/IgnorantGuru/spacefm/tarball/master
    tar xzf spacefm.tar.gz
    cd IgnorantGuru-spacefm-*

    # Build & Install
    ./configure --enable-hal
    make -s
    sudo make install
    sudo update-mime-database /usr/local/share/mime > /dev/null
    sudo update-desktop-database -q
    sudo gtk-update-icon-cache -q -t -f /usr/local/share/icons/hicolor
    sudo gtk-update-icon-cache -q -t -f /usr/local/share/icons/Faenza

    # Remove Temporary Files
    cd / && rm -rf /tmp/spacefm-build

NOTES:
a) If configure reports missing dependencies, install them and run
   configure again before proceeding to make.

b) Enabling kernel polling is recommended after installing SpaceFM:
   http://ignorantguru.github.io/spacefm/spacefm-manual-en.html#devices-kernpoll

c) SpaceFM supports ktsuss, gksu, gksudo, gnomesu, kdesu, and xdg-su.
   To build with an additional custom su program ('/usr/bin/mysu' in this
   example), add:
      --with-preferable-sudo=/usr/bin/mysu   # to the configure command

BUILD NEXT

The git 'next' branch of SpaceFM is a work in progress which eventually becomes the next release version. To build from this branch, install the required build dependencies listed above for your build, then:

# Download & Extract
mkdir /tmp/spacefm-next && cd /tmp/spacefm-next
wget -O spacefm-next.tar.gz https://github.com/IgnorantGuru/spacefm/tarball/next
tar xzf spacefm-next.tar.gz
cd IgnorantGuru-spacefm-*

# Build & Install
./configure
make -s
sudo make install
sudo update-mime-database /usr/local/share/mime > /dev/null
sudo update-desktop-database -q
sudo gtk-update-icon-cache -q -t -f /usr/local/share/icons/hicolor
sudo gtk-update-icon-cache -q -t -f /usr/local/share/icons/Faenza

# Remove Temporary Files
cd / && rm -rf /tmp/spacefm-next

BUILD DEBUG

If SpaceFM crashes or hangs on your system, you can help to correct this problem by reporting it, including a full backtrace.

IF you are using Arch Linux, you can perform step 2 below, then install the AUR spacefm-git package, which enables debugging.

For other distros:

1) Install build dependencies for your build (see BUILD sections above).

2) Install the 'gdb' GNU Debugger, and debugging symbols for gtk. For example on Debian, this is done like this (packages on other distros should have similar names):

apt-get install gdb libc6-dbg libglib2.0-0-dbg libgtk2.0-0-dbg librsvg2-dbg

3) Use these commands to download the SpaceFM tarball and build:

    # Download & Extract
    mkdir /tmp/spacefm-build && cd /tmp/spacefm-build
    # substitute 'next' for 'master' below if next branch is desired
    wget -O spacefm.tar.gz https://github.com/IgnorantGuru/spacefm/tarball/master
    tar xzf spacefm.tar.gz
    cd IgnorantGuru-spacefm-*

    # Build & Install
    CFLAGS='-ggdb3 -O1' STRIP='!strip' ./configure  # pass any options here
    make -s
    sudo make install
    sudo update-mime-database /usr/local/share/mime > /dev/null
    sudo update-desktop-database -q
    sudo gtk-update-icon-cache -q -t -f /usr/local/share/icons/hicolor
    sudo gtk-update-icon-cache -q -t -f /usr/local/share/icons/Faenza

    # Remove Temporary Files
    cd / && rm -rf /tmp/spacefm-build

4) Run spacefm with the debugger:

    gdb /usr/local/bin/spacefm

In gdb, enter 'run' at the prompt.  SpaceFM will start.  When the crash
occurs, gdb will freeze SpaceFM.  If SpaceFM hangs, press Ctrl-C in gdb to
interrupt it, or run 'killall -s KILL spacefm' in another terminal.

5) In the terminal running gdb enter 'bt full'. Provide the output with your detailed bug report at https://github.com/IgnorantGuru/spacefm/issues

NOTE: When SpaceFM is built this way, it may run more slowly and use more
memory.  Once you are done debugging, be sure to install a normal
(optimized) build.

CREATE DEB PACKAGE

To build a deb file of SpaceFM on your Debian-based distro:

1) Install build dependencies for your build (see above), plus debhelper.

2) Use these commands to download and extract the SpaceFM tarball (be sure to USE A TMP BUILD PATH THAT DOES NOT CONTAIN SPACES):

    mkdir /tmp/spacefm-build && cd /tmp/spacefm-build   # no spaces in path
    # Note: you can change "master" to "next" if you want the next branch:
    wget -O spacefm.tar.gz https://github.com/IgnorantGuru/spacefm/tarball/master
    tar xzf spacefm.tar.gz
    cd IgnorantGuru-spacefm-*

3) Move the distros/debian directory into the source directory:

    mv distros/debian .

NOTE: For newer Debian versions, some adjustments to the control file
(dependencies) may be necessary, or use official Debian packages.

4) IF GTK3 support IS desired:

    cp debian/control-gtk3 debian/control
    cp debian/rules-gtk3 debian/rules
    sed -i 's/^spacefm \(.*\)/spacefm-gtk3 \1/' debian/changelog

5) IF hal support IS desired (cannot be used with GTK3 unless you edit rules):

    cp debian/control-hal debian/control
    cp debian/rules-hal debian/rules
    sed -i 's/^spacefm \(.*\)/spacefm-hal \1/' debian/changelog

6) Build package: (the package files will appear in the parent directory)

    dpkg-buildpackage -b -uc
    cd .. && rm -rf IgnorantGuru-spacefm-* spacefm.tar.gz

7) To install the package you built:

    dpkg -i spacefm*.deb

UNINSTALL

If you installed from a package, use your package manager to remove SpaceFM. Otherwise, run these commands AS ROOT:

rm /usr/local/bin/spacefm /usr/local/bin/spacefm-auth
rm -r /usr/local/share/spacefm
rm /usr/local/share/pixmaps/spacefm.png
rm /usr/local/share/pixmaps/spacefm-*.png
rm /usr/local/share/icons/hicolor/*/apps/spacefm.png
rm /usr/local/share/icons/hicolor/*/apps/spacefm-*.png
rm /usr/local/share/icons/Faenza/apps/48/spacefm.png
rm /usr/local/share/icons/Faenza/apps/48/spacefm-*.png
rm /usr/local/share/locale/*/LC_MESSAGES/spacefm.mo
rm /usr/local/share/applications/spacefm*.desktop
rm /usr/local/share/mime/packages/spacefm-mime.xml
update-mime-database /usr/local/share/mime > /dev/null
update-desktop-database -q
gtk-update-icon-cache -q -t -f /usr/local/share/icons/hicolor

ENABLE KERNEL POLLING

You may need to enable kernel polling for device media changes to be
detected by SpaceFM.  For example, if you insert a CD and SpaceFM still
says 'no media', this is a symptom that kernel polling is not enabled.

Kernel polling is a newer feature of the Linux kernel and udev, so some
distros don't yet have it enabled by default.  To use kernel polling,
your Linux kernel may need to be 2.6.38 or newer, and udev may need to
be version 173 or newer.

TO DETERMINE IF KERNEL POLLING IS ENABLED:

    cat /sys/module/block/parameters/events_dfl_poll_msecs
    cat /sys/block/sr0/events_poll_msecs

If you get 0 or -1 from both of those commands, kernel polling may be
disabled.

TO ENABLE KERNEL POLLING PERMANENTLY (survives a reboot), add the
following command to your /etc/rc.local file (anywhere before the
'exit' line in that file):

    echo 2000 > /sys/module/block/parameters/events_dfl_poll_msecs

Any number between 2000 and 5000 (milliseconds) should be reasonable -
the higher 5000 means poll every 5 seconds, which is less overhead but
a little slower.

OR pass this option to the kernel boot command line in grub:

    block.events_dfl_poll_msecs=2000

OR add a udev rule to enable kernel polling on removable devices:

    echo 'ACTION=="add", ATTR{removable}=="1", \
          ATTR{events_poll_msecs}=="-1", ATTR{events_poll_msecs}="2000"' \
          > /etc/udev/rules.d/61-removable-storage-polling.rules

A reboot will be required for the above changes to take effect, or...

TO ENABLE KERNEL POLLING TEMPORARILY AND IMMEDIATELY, enable common
polling for the block module:

    sudo bash -c 'echo 2000 > /sys/module/block/parameters/events_dfl_poll_msecs'

OR you can enable polling just for a single device like this (/dev/sr0
in this example):

    sudo bash -c 'echo 2000 > /sys/block/sr0/events_poll_msecs'

This change should be immediate - media will be detected.  However, the
above change will be lost when you reboot.

References:
http://www.mail-archive.com/lfs-dev@linuxfromscratch.org/msg15714.html
http://blogs.gentoo.org/mgorny/2011/06/20/uam-can-now-mount-cds-and-dvds/
https://bugs.archlinux.org/task/25609
http://unix.stackexchange.com/questions/38582/

TRANSLATE

To help translate SpaceFM please visit:
    https://github.com/IgnorantGuru/spacefm/wiki/Translate

At Transifex:
    https://www.transifex.com/projects/p/spacefm/resource/spacefmpot_1/

Just sign up for a free Transifex account.  For instructions visit:
    http://help.transifex.com/intro/translating.html#translating

LICENSE

SpaceFM - Copyright (C) 2014  GPL3+

This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3 of the License, or (at your
option) any later version.

USE AT YOUR OWN RISK.  This program is distributed in the hope that it
will be useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
the GNU General Public License for more details.

The 'exo' libraries and source code used by this software are licensed
under the GNU General Public License and the GNU Lesser General Public
License version 3 (LGPL3).

You should have received a copy of the GNU General Public License and
the GNU Lesser General Public License along with this program; if not,
write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
Floor, Boston, MA  02110-1301, USA.

See COPYING and COPYING-LGPL files.

DERIVATIVE WORKS

If you plan to publish a significant amount of or the full source to
SpaceFM with your modifications, please see the following wiki article:

https://github.com/IgnorantGuru/spacefm/wiki/Guidelines-For-Distributing-Modifications

BwackNinja / spacefm

readme