Git commit 9a584ee60f161b8aedd861131471c7f62bba1264 by Pino Toscano. Committed on 06/04/2019 at 08:53. Pushed by pino into branch 'master'.
doc: drop almost all bits related to installation Summary: In the majority of the cases, users install krusader as available in their distribution, and thus most of this content is not useful; users that want to compile krusader from sources find already instructions on krusader.org and in the in-source INSTALL files, so no need to duplicate them in a user-taylored documentation. Just link to the online page on krusader.org. Furthermore: - instructions related to building distro package are definitely not in the scope of an user documentation - the bits about krusaderui.rc are wrong, since this is is actually a bug in krusader (i.e. krusaderui.rc was changed without bumping its version) - links to distro packages (including macOS and Windows ones) either are obsolete, or simply not useful - the reference of the command line options is not useful for general users starting krusader graphically; for console users there is already the krusader man page with these bits of information (so no need to duplicate them) - the instructions for changing the default file manager are obsolete Test Plan: - build the documentation - verify the mentioned bits are not present Reviewers: yurchor Reviewed By: yurchor Subscribers: yurchor, kde-doc-english Tags: #documentation Differential Revision: https://phabricator.kde.org/D20287 M +1 -3 doc/configuration-files.docbook M +1 -2 doc/editors-note.docbook M +10 -389 doc/faq.docbook M +1 -2 doc/features.docbook M +0 -15 doc/help.docbook M +0 -2 doc/index.docbook D +0 -727 doc/installation.docbook M +1 -3 doc/keyboard-commands.docbook M +1 -3 doc/profiles.docbook https://commits.kde.org/krusader/9a584ee60f161b8aedd861131471c7f62bba1264 diff --git a/doc/configuration-files.docbook b/doc/configuration-files.docbook index 188e8a1f..a884e317 100644 --- a/doc/configuration-files.docbook +++ b/doc/configuration-files.docbook @@ -27,9 +27,7 @@ <emphasis role="bold">krusaderui.rc</emphasis> </para> <para>This file stores the users toolbar settings and the menu - structure. Tip: read also the - <link linkend="faqi_missing_menus">krusaderui.rc - &FAQ;</link>.</para> + structure.</para> <para>Location: <filename>/usr/share/kxmlgui5/krusader/krusaderui.rc</filename>, or <filename> diff --git a/doc/editors-note.docbook b/doc/editors-note.docbook index 44a9a221..97bff907 100644 --- a/doc/editors-note.docbook +++ b/doc/editors-note.docbook @@ -53,8 +53,7 @@ <para>The most recent version of this handbook is available when using &krusader; from Git.</para> <note><para> - If you are using a <link linkend="krusader_devel">development</link> or - <link linkend="krusader_git">Git</link> version, it is possible that the latest + If you are using a development or &git; version, it is possible that the latest new features are not yet in the "The &krusader; Handbook". Please read the <ulink url="https://commits.kde.org/krusader?path=ChangeLog">Changelog</ulink> diff --git a/doc/faq.docbook b/doc/faq.docbook index c5c46ece..ffc11ffd 100644 --- a/doc/faq.docbook +++ b/doc/faq.docbook @@ -22,7 +22,9 @@ <primary>FAQ</primary> </indexterm> <para>If you have problems with &krusader; please - check the <link linkend="installation">Installation procedure</link>, as your problem may be + check the + <ulink url="https://krusader.org/get-involved/index.html">installation + procedure</ulink>, as your problem may be caused by a bad installation.</para> <para>The &FAQ; is divided into three sections: <itemizedlist> @@ -103,180 +105,9 @@ <!-- Empty line to make it more readable --> </answer> </qandaentry> - <qandaentry> - <question id="faqi_libs"> - <para>Which libraries does &krusader; need to - run?</para> - </question> - <answer> - <para>For running &krusader; (⪚ - when you have installed &krusader; with a - binary RPM) you need less libraries than if you compile - &krusader; from source. ⪚ you - only need the C-compiler &gcc; when you - compile &krusader; from source (see the next - question).</para> - <para>Take a look at the <link linkend="compilation">&krusader; dependencies</link> paragraph of our install chapter.</para> - <para> - If you need more details please take a look - at the <ulink url="https://packages.ubuntu.com/cosmic/krusader">&krusader; requirements</ulink> on Ubuntu. - The "depends" are required, the "suggests" make &krusader; more powerful.</para> - <para></para> - <!-- Empty line to make it more readable --> - </answer> - </qandaentry> - <qandaentry> - <question id="faqi_missing_libs"> - <para>I have followed all the steps but - <command>make</command> complains about missing libs - or headers. What do I need to do?</para> - </question> - <answer> - <para>Install the missing packages.</para> - <para>Take a look at the <link linkend="compilation">Compilation requirements</link> paragraph of our install chapter.</para> - <para>Most RPM-based distributions separate the headers - from the libs. The headers are needed to compile - &krusader;. Look for packages in the form - foo-devel-*.rpm (⪚ - <filename>kdelibs-devel-foo.i586.rpm</filename>) or - foo-dev-*.deb for <trademark class="registered">Debian</trademark> based - distributions. These are usually included with your - distribution. - <tip> - <para>If you cannot find the needed package, use - <ulink url="http://rpmfind.net/linux/rpm2html/search.php?query=krusader&submit=Search+...">rpmfind</ulink> and click 'missing lib or - header' in the search line. Or use - <command>apt-cache search - <replaceable>foo</replaceable></command> to find the - corresponding package for <trademark class="registered">Debian</trademark> based - distributions.</para> - </tip></para> - <para></para> - <!-- Empty line to make it more readable --> - </answer> - </qandaentry> - <qandaentry> - <question id="faqi_64bit"> - <para>How do I compile &krusader; when I am - using a 64 bit processor?</para> - </question> - <answer> - <para>As far as we know, there are no issues. - &krusader; is also available on - <ulink url="https://packages.debian.org/unstable/utils/krusader"> - many other architectures</ulink>.</para> - <para></para> - <!-- Empty line to make it more readable --> - </answer> - </qandaentry> - <qandaentry> - <question id="faqi_rpm-source"> - <para>I have downloaded the Source RPM - <filename>krusader-x.xx.dist.src.rpm</filename>, what to - do now?</para> - </question> - <answer> - <para> - <orderedlist> - <listitem> - <para>Check the ownership and the permissions on - <filename class="directory"> - /usr/src/RPM/</filename> and all recursive - directories that your normal user can - read-write-execute in these directories.</para> - </listitem> - <listitem> - <para>To produce the binary RPM for your computer, - do this: - <screen><prompt>$</prompt> <userinput><command>rpm</command> <option>--rebuild</option> <replaceable></path/to/rpmfile/> krusader-x.xx.dist.src.rpm</replaceable></userinput></screen> - </para> - </listitem> - <listitem> - <para>If all - <link linkend="faqi_missing_libs"> - dependencies</link> are OK, a binary RPM - <filename>krusader-x.xx.dist.rpm</filename> will be - created at - <filename class="directory"> - /usr/src/RPM/RPMS/i586</filename> (replace i586 with - your architecture).</para> - </listitem> - <listitem> - <para>Test the binary RPM for errors before - installing: - <screen><prompt>$</prompt> <userinput><command>rpm</command> <option>-i --test</option> <replaceable></path/to/rpmfile> krusader-x.xx.dist.rpm</replaceable></userinput></screen> - If the prompt returns without any message, - then everything is OK.</para> - </listitem> - <listitem> - <para>Install the binary RPM as usual, for example: - <screen><prompt>$</prompt> <userinput><command>su -c 'rpm</command> <option>-Uvh</option> <replaceable></path/to/rpmfile> krusader-x.xx.dist.rpm</replaceable>'</userinput></screen> - You will be asked to enter your root - password.</para> - </listitem> - <listitem> - <para>Now you can - <link linkend="starting-krusader"> - start</link> &krusader;.</para> - </listitem> - </orderedlist> - </para> - <para></para> - <!-- Empty line to make it more readable --> - <tip> - <para>For more information about RPM, visit - <ulink url="http://www.rpm.org/">rpm.org</ulink> and read the - <ulink url="https://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/RPM_Guide/index.html">RPM Guide</ulink> - by Eric Foster-Johnson.</para> - </tip> - <para></para> - <!-- Empty line to make it more readable --> - </answer> - </qandaentry> - <qandaentry> - <question id="faqi_rpm-fails"> - <para>I am trying to install binary foo (RPM or DEB - package), but it fails. What is wrong?</para> - </question> - <answer> - <para>Since we only prepare (and use) the source, we have - no way of knowing this. Did you test the binary RPM - before installing? - <screen><prompt>$</prompt> <userinput><command>rpm</command> <option>-i --test</option> <replaceable></path/to/rpmfile> krusader-x.xx.dist.rpm</replaceable></userinput></screen> - If the prompt returns without any message, then - everything is OK. RPM's downloaded from our website are - usually provided by &krusader; users. Visit - your distro website and search for an updated RPM.</para> - <para>If the RPM is not OK, try to find another package - at &Linux; software archives such as - <ulink url="http://freshmeat.net/projects/krusader/">freshmeat.net</ulink> or <ulink url="https://www.linux-apps.com/content/show.php?content=10214">linux-apps.com</ulink>. - If you still cannot find the appropriate package for your - &Linux; distribution, we recommend searching - for it with <ulink url="http://rpmfind.net/linux/rpm2html/search.php?query=krusader&submit=Search+...">rpmfind</ulink> or - <ulink url="http://rpm.pbone.net/index.php3/stat/3/search/krusader">rpmpbone</ulink>.</para> - <para>In general, a package for an older version of your - distribution or even for another distribution might work - on your computer (⪚ FC RPM's often work on - Mdk and RH, and vice versa), but it is always the best - that you install only RPM's that exactly match your - distribution. If you cannot find a package that matches - your distribution version, architecture or distribution, - then use a source RPM. When you use a source RPM, the - Krusader sources will be built, on your computer, - guaranteeing a suitable binary RPM for your specific - distribution and architecture. In addition, this method - results in maximum system speed, since the resulting - binary is customized for your computer. Please read the - previous question, it explains how to install a source - RPM. The best solution is explained in the next - question.</para> - <para></para> - <!-- Empty line to make it more readable --> - </answer> - </qandaentry> <qandaentry> <question id="faqi_rpm-notfound"> - <para>I cannot find an RPM or DEB package for + <para>I cannot find a package for &krusader;, what to do?</para> </question> <answer> @@ -284,86 +115,17 @@ &krusader;, if it does not then contact your distribution creator and ask them to include &krusader;!</para> - <para>Did you take a look at the &URL;s on - the <link linkend="installation">Installation procedure</link> page? If you have and + <para>Did you take a look at the + <ulink url="https://krusader.org/get-involved/index.html">installation + procedure</ulink> page? If you have and found nothing, you can always compile - &krusader; from source. Even if you feel you - have not got the necessary skills, you will probably - succeed in compiling &krusader;: we provide a - very detailed installation procedure. This HowTo enables - newcomers to compile &krusader; from source, - even if they have never done a compilation from source - before, just follow the instructions carefully. Feel free + &krusader; from source. Feel free to post a <link linkend="faqi_help_request">help request</link> if you encounter problems.</para> <para></para> <!-- Empty line to make it more readable --> </answer> </qandaentry> - <qandaentry> - <question id="faqi_missing_menus"> - <para>Some new menu items are missing after updating - &krusader;, what is wrong?</para> - </question> - <answer> - <para>The - <filename>krusaderui.rc</filename> file is stored in - <filename> - /usr/share/kxmlgui5/krusader/krusaderui.rc</filename>. - When you change the - <guilabel>Toolbar</guilabel>, &plasma; makes a - copy of that file in the home folder at - <filename> - ~/.local/share/kxmlgui5/krusader/krusaderui.rc</filename>. If - &krusader; was previously installed on your computer, and - you install a newer &krusader; version the - <filename> - ~/.local/share/kxmlgui5/krusader/krusaderui.rc</filename> file - must be replaced with the newer version. Note: this will - also reset all your changes on toolbars and - shortcuts!</para> - <para>The first line of - <filename>krusaderui.rc</filename> contains the version - number. After installing a newer &krusader; - version, &plasma; will automatically replace the - old - <filename> - ~/.local/share/kxmlgui5/krusader/krusaderui.rc</filename> with - the newer version when starting the new - &krusader; for the first time - (&plasma; will detect the newer version number in - the first line).</para> - <para>If you install a development or beta version and - &krusader; was already installed on your - computer then you should delete the - <filename>krusaderui.rc</filename> file from your home - directory to activate the new menu entries - <prompt>$</prompt> - <userinput> - <command>rm</command> - <option> - ~/.local/share/kxmlgui5/krusader/krusaderui.rc</option> - </userinput></para> - <para>If the - <filename> - ~/.local/share/kxmlgui5/krusader/krusaderui.rc</filename> file - is older, then the new menu elements will not be shown. - Read the previous question for information on how to - update the - <filename>krusaderui.rc</filename> file. If - <filename>krusaderui.rc</filename> is missing or in a - wrong directory, only the - <guimenu>Help</guimenu> menu appears, please read the - previous question.</para> - <note> - <para> - The default folder for the local configuration file <filename>kxmlgui5/krusaderui.rc</filename> is <filename class="directory">~/.local/share</filename>. You can determine the needed folder in your system using the <userinput>qtpaths --paths GenericDataLocation</userinput> command in terminal. - </para> - </note> - <para></para> - <!-- Empty line to make it more readable --> - </answer> - </qandaentry> <qandaentry> <question id="faqi_help_request"> @@ -373,8 +135,8 @@ </question> <answer> <para>Please read our detailed - <link linkend="compilation">installation - procedure</link> and the <link linkend="faq">FAQ</link>. If you + <ulink url="https://krusader.org/get-involved/index.html">installation + procedure</ulink> and the <link linkend="faq">FAQ</link>. If you cannot find a solution to your problem then feel free to post a <emphasis role="bold">help request</emphasis> at our @@ -422,90 +184,6 @@ <!-- Empty line to make it more readable --> </answer> </qandaentry> - <qandaentry> - <question id="faqi_rpm-build"> - <para>How can I build an RPM package for - &krusader;?</para> - </question> - <answer> - <para>If you have experience with compiling from source, - you will probably be able to build a - &krusader; RPM too. Information about RPM can - be found at <ulink url="http://www.rpm.org/">rpm.org</ulink> and in the - <ulink url="https://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/RPM_Guide/index.html">RPM Guide</ulink> - by Eric Foster-Johnson. The - following is the short procedure howto on building an - RPM.</para> - <warning> - <para>NEVER build RPMs when logged in as root. Mistakes - in building packages (⪚ a bad - <filename>krusader.spec</filename> file) can do serious - damage to your system when logged in as root.</para> - </warning> - <para> - <orderedlist> - <listitem> - <para>Compile &krusader; from source to - check that the compilation works fine.</para> - </listitem> - <listitem> - <para>Check the ownership and the permissions on - <filename class="directory"> - /usr/src/RPM/</filename> and all recursive - directories that your normal user can - read-write-execute in these directories.</para> - </listitem> - <listitem> - <para>Copy - <filename>krusader-1.xx.tar.gz</filename> to - <filename class="directory"> - /usr/scr/RPM/SOURCE</filename></para> - </listitem> - <listitem> - <para>Copy - <filename>krusader.spec</filename> to - <filename class="directory"> - /usr/scr/RPM/SPECS</filename></para> - </listitem> - <listitem> - <para>Edit - <filename>krusader.spec</filename> and add your name, - your email address, the rpm name, ... Other - changes may be needed if - <command>rpmbuild</command> fails.</para> - </listitem> - <listitem> - <para>Build the binary and the source RPM with: - <screen><prompt>$</prompt> <userinput><command>rpmbuild</command> <option>-ba</option> <replaceable>/usr/scr/RPM/SPECS/krusader.spec</replaceable></userinput></screen> - If everything went OK you will have a - binary RPM in - <filename class="directory"> - /usr/src/RPM/RPMS/i586</filename> (depending on your - architecture) and a source RPM in - <filename class="directory"> - /usr/src/RPM/SRPMS/</filename> ⪚ - <filename> - krusader-1.70-beta1.suse10.i586.rpm</filename> and - <filename> - krusader-1.70-beta1.suse10.src.rpm</filename></para> - </listitem> - <listitem> - <para>If the build is not OK you will receive an - error message during the rpmbuild process, try to - fix it and run - <command>rpmbuild</command> again.</para> - </listitem> - <listitem> - <para>And finally: - <link linkend="faqi_rpm-source">test</link> the RPM - before sending it in.</para> - </listitem> - </orderedlist> - </para> - <para></para> - <!-- Empty line to make it more readable --> - </answer> - </qandaentry> <qandaentry> <question id="faqi_git_version"> <para>Why does &krusader;-git show an old @@ -521,30 +199,6 @@ <!-- Empty line to make it more readable --> </answer> </qandaentry> - <qandaentry> - <question id="faqi_mac_dbus"> - <para>Why does &krusader; not start on &MacOS;?</para> - </question> - <answer> - <para>Please read carefully the <ulink url="https://www.macports.org/">macports.org</ulink> - installation instructions. Do not forget to start <application>dbus</application>. - <screen>########################################################## -# Do not forget that dbus needs to be started as the local -# user (not with sudo) before any KDE programs will launch -# To start it run the following command: -# launchctl load /Library/LaunchAgents/org.freedesktop.dbus-session.plist -########################################################## - -###################################################### -# Programs will not start until you run the command -# 'sudo chown -R $USER ~/Library/Preferences/KDE' -# replacing $USER with your username. -###################################################### - </screen></para> - <para></para> - <!-- Empty line to make it more readable --> - </answer> - </qandaentry> </qandaset> </sect1> <sect1 id="faq_usage"> @@ -1328,39 +982,6 @@ <!-- Empty line to make it more readable --> </answer> </qandaentry> - <qandaentry> - <question id="faqg_mac"> - <para>Is there a &MacOS; X port?</para> - </question> - <answer> - <para>Yes, there is a <link linkend="kde4_mac_install">&MacOS;-X port</link> - with the help of <ulink url="https://www.macports.org/">macports.org</ulink> , the port is - maintained by <ulink url="https://krusader.org/developers.php">Jonas Bähr</ulink>, - all feedback is welcome. - A recommended native file manager for &MacOS; is - <ulink url="http://www.likemac.ru/english/"><trademark class="copyright">Disk Order</trademark></ulink> (shareware).</para> - <para></para> - <!-- Empty line to make it more readable --> - </answer> - </qandaentry> - <qandaentry> - <question id="faqg_win"> - <para>Is there a &Windows; port?</para> - </question> - <answer> - <!-- the port is unavailable now - <para>Yes, there is a <link linkend="kde4_win_install">&Windows; port</link> since 18 June 2008. - Before &krusader; can be used several &Qt;4-libraries and &kde;4-libraries need to be installed.--> - <para>No, there was a port but it is unmaintained and unavailable now. A recommended native file manager for &Windows; is - <ulink url="https://www.ghisler.com/"><trademark class="copyright">Total Commander</trademark></ulink> (shareware).</para> - <para>If you want to help with porting please join <ulink url="http://windows.kde.org/">The KDE on Windows Initiative</ulink>. - Some useful tips on porting can be found in the - <ulink url="https://commits.kde.org/krusader?path=INSTALL"><filename>INSTALL</filename></ulink> - file of the &krusader; sources, it contains all latest compilation instructions.</para> - <para></para> - <!-- Empty line to make it more readable --> - </answer> - </qandaentry> <qandaentry> <question id="faqg_mcstyle"> <para>Why is &konqueror; in "midnight diff --git a/doc/features.docbook b/doc/features.docbook index cffa00e8..d91f1cec 100644 --- a/doc/features.docbook +++ b/doc/features.docbook @@ -504,8 +504,7 @@ </para> <para><note><para> - If you are using a <link linkend="krusader_devel">development</link> or - <link linkend="krusader_git">Git</link> version, it is possible that the latest + If you are using a development or &git; version, it is possible that the latest new features are not yet in the "The &krusader; Handbook". Please read the <ulink url="https://commits.kde.org/krusader?path=ChangeLog">Changelog</ulink> diff --git a/doc/help.docbook b/doc/help.docbook index 88a52037..a308d3a4 100644 --- a/doc/help.docbook +++ b/doc/help.docbook @@ -81,21 +81,6 @@ </para> <para>We are always in need of packagers for different distro rpm's, deb's, etc. All help is welcome.</para> - <para> - <emphasis role="bold">Users' feedback for the - &krusader; &MacOS; X port</emphasis> - </para> - <para>There is a <link linkend="kde4_mac_install">&MacOS;-X port</link> - with the help of <ulink url="https://www.macports.org/">macports.org</ulink> , the port was - maintained by Jonas Bähr, - all feedback is welcome.</para> -<!-- Windows port is unavailable now - <para><emphasis role="bold">Users' feedback for the - &krusader; &Windows; port</emphasis> - </para> - <para>There is a <link linkend="kde4_win_install">&Windows; port</link> since 18 June 2008. - It needs &Qt; and &kde;libs to run. - All feedback is welcome.</para>--> <para> <emphasis role="bold">FAQ</emphasis> </para> diff --git a/doc/index.docbook b/doc/index.docbook index bc2a1713..7b665c62 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -77,7 +77,6 @@ <!ENTITY faq SYSTEM "faq.docbook"> <!ENTITY credits-and-license SYSTEM "credits-and-license.docbook"> <!-- OLD: credits.docbook NEW: credits-and-license.docbook --> <!ENTITY glossary SYSTEM "glossary.docbook"> - <!ENTITY installation SYSTEM "installation.docbook"> <!-- appendices in separate docbook files --> <!ENTITY configuration-files SYSTEM "configuration-files.docbook"> @@ -356,7 +355,6 @@ &konfigurator; &faq; &credits-and-license; - &installation; <!-- appendices --> &configuration-files; diff --git a/doc/installation.docbook b/doc/installation.docbook deleted file mode 100644 index b0aa9052..00000000 --- a/doc/installation.docbook +++ /dev/null @@ -1,727 +0,0 @@ -<!-- ********************************************************************** - copyright : (C) 2000-2018 - Rafi Yanai, Shie Erlich, Frank Schoolmeesters - & the Krusader Krew - e-mail : krusader-de...@googlegroups.com - web site : https://krusader.org - description : a Krusader Documentation File - -*************************************************************************** -* Permission is granted to copy, distribute and/or modify this * -* document under the terms of the GNU Free Documentation License, * -* Version 1.1 or any later version published by the Free Software * -* Foundation; with no Invariant Sections, no Front-Cover Texts and * -* no Back-Cover Texts. A copy of the license is available on the * -* GNU site https://www.gnu.org/licenses/fdl.html or by writing to: * -* Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, * -* MA 02111-1307, USA. * -*********************************************************************** --> -<chapter id="installation"> - <title>Installation of Krusader</title> - <indexterm> - <primary>Installation</primary> - </indexterm> - <sect1 id="requirements"> - <title>Requirements</title> - <para>In order to successfully use the most recent - &krusader;, you need &kf5; - >= 5.18</para> -<para>Required &kde; version:</para> - <itemizedlist> - <listitem> - <para>&krusader; v1.01: &kde; - 2</para> - </listitem> - <listitem> - <para>&krusader; v1.02 - 1.40: &kde; - 3.0 - &kde; 3.2</para> - </listitem> - <listitem> - <para>&krusader; 1.40: prefers &kde; - 3.2 (otherwise all features will not be available)</para> - </listitem> - <listitem> - <para>&krusader; v1.50 - v1.51: &kde; - 3.2 - &kde; 3.3 (Konfigurator crash on - &kde; 3.4)</para> - </listitem> - <listitem> - <para>&krusader; v1.60.0 - v1.70.0: - &kde; 3.3 - &kde; 3.5</para> - </listitem> - <listitem> - <para>&krusader; 1.70.x: prefers - &kde; >= 3.4 (otherwise all - features will not be available)</para> - </listitem> - <listitem> - <para>&krusader; 1.80.0: &kde; 3.4 - - &kde; 3.5</para> - </listitem> - <listitem> - <para>&krusader; 1.90.0: &kde; 3.2 - - &kde; 3.5</para> - </listitem> - <listitem> - <para>&krusader; v2.4.x: &kde; 4.x</para> - </listitem> - <listitem> - <para>&krusader; v2.5.x: &kf5-full;</para> - </listitem> - </itemizedlist> - <para>Platforms: - <itemizedlist> - <listitem> - <para>All POSIX - (&Linux;/BSD/&UNIX;-like OSes), - &Solaris;</para> - </listitem> - <listitem> - <para>All BSD Platforms - (<trademark class="copyright">FreeBSD</trademark>/<trademark class="registered">NetBSD</trademark>/<trademark class="registered">OpenBSD</trademark>/&MacOS;)</para> - </listitem> - <!-- Not here anymore - <listitem> - <para>&Windows; XP and Vista</para> - </listitem>--> - </itemizedlist></para> - <para>In order to handle archives, checksums and other utilities they must be configured in our - <link linkend="konfig-dependencies">configuration tool</link>. - When running &krusader; for the first time the available utilities will be autodetected, and - a report will be shown in the first lanch wizard. Afterwards additional utilities can be - <link linkend="konfig-dependencies">added/removed/changed</link>.</para> - <para>A package of popular (un)packers, &krusader; - itself and add-ons can be found on the - <ulink url="https://krusader.org/get-krusader/index.html">&krusader; download page</ulink>.</para> - <para>For more requirements, see below. Have a look at the - <link linkend="faq">FAQ</link> section as well.</para> - </sect1> - <sect1 id="getting-krusader"> - <title>Obtaining &krusader;</title> - <para>The latest information about &krusader; can be - found on the <ulink url="https://krusader.org">Krusader website</ulink> .</para> - <sect2 id="krusader-download"> - <title>&krusader; Downloads</title> - <para>It is recommended to use the &krusader; package - that is provided by your distribution. - <ulink url="https://distrowatch.com/search.php?pkg=krusader">Distrowatch.com</ulink> is a great resource to check - the availability. If your distribution does not offer - &krusader;, please contact the creators of your - distribution and ask them to provide a &krusader; - package</para> - <para>The latest version, as well as the older versions, can - be found on the <ulink url="https://krusader.org/get-krusader/index.html">&krusader; download page</ulink> (current version) and on the - <ulink url="http://sourceforge.net/project/showfiles.php?group_id=6488">Sourceforge mirrors</ulink> (outdated versions). It contains the source tarballs, - RPM and DEB packages to whatever distro the - &krusader;-Krew is using and packages build by - &krusader; users and third parties.</para> - <para>Distributions who provide &krusader;:</para> - <itemizedlist> - <listitem> - <para><ulink url="https://www.suse.com/">&SuSE;</ulink></para> - </listitem> - <listitem> - <para><ulink url="https://admin.fedoraproject.org/pkgdb/package/rpms/krusader/"><trademark>Fedora</trademark></ulink> via - <command># dnf install krusader</command> will do the job.</para> - </listitem> - <listitem> - <para><ulink url="https://packages.debian.org/krusader"><trademark class="registered">Debian</trademark></ulink>, on our - <ulink url="https://krusader.org/get-krusader/index.html">&krusader; download page</ulink> you might find more recent - DEB packages. Note: usually <trademark class="registered">Debian</trademark> packages - work also on distributions that are "based on - <trademark class="registered">Debian</trademark>", and some of these provide their own - (incompatible) packages. - <ulink url="https://packages.ubuntu.com/krusader"><trademark class="registered">Ubuntu</trademark>/<trademark class="registered">Kubuntu</trademark></ulink>, - <trademark class="registered">Knoppix</trademark> - 4.x DVD, <trademark class="registered">Kanotix</trademark>, &etc;</para> - </listitem> - <listitem> - <para><ulink url="https://madb.mageia.org/package/show/name/krusader"><trademark class="registered">Mageia</trademark></ulink> via the contrib repository - <command># urpmi krusader</command> will do the job.</para> - </listitem> - <listitem> - <para><ulink url="https://packages.gentoo.org/package/kde-misc/krusader"><trademark class="registered">Gentoo</trademark></ulink>.</para> - </listitem> - <listitem> - <para><ulink url="https://www.archlinux.org/packages/community/x86_64/krusader/"><trademark class="registered">Arch Linux</trademark></ulink>, - <ulink url="http://frugalware.org/packages.php?id=280"><trademark class="registered">Frugalware Linux</trademark></ulink>, - <trademark class="registered">PCLinuxOS</trademark>, - <ulink url="www.altlinux.com/"><trademark class="registered">ALT Linux</trademark></ulink>.</para> - </listitem> - <listitem> - <para><ulink url="https://www.freebsd.org/cgi/ports.cgi?query=krusader&stype=all"><trademark class="copyright">FreeBSD</trademark></ulink>, the port was - maintained by - <link linkend="credits">Heiner Eichmann</link>.</para> - </listitem> - <listitem> - <para><ulink url="https://pkgsrc.se/sysutils/krusader"><trademark class="registered">NetBSD</trademark></ulink>, - <ulink url="http://www.lunar-linux.org/"><trademark class="registered">Lunar Linux</trademark></ulink> - ,<trademark class="registered">Ark Linux</trademark>, <trademark>OpenLX</trademark>.</para> - </listitem> - <listitem> - <para>More distributions can be found with - <ulink url="https://distrowatch.com/search.php?pkg=krusader">Distrowatch.com</ulink>.</para> - </listitem> - </itemizedlist> - <para>Use the installation tools included in your - distro to install the &krusader; package. You - might need an internet connection if &krusader; is - not included on the &CD; or DVD. There are - probably other distributions which include - &krusader;. If you know of one, please send - feedback so that we can include it on the distrolist.</para> - <para>Others - <itemizedlist> - <listitem> - <para><trademark class="registered">Slackware</trademark> txz binaries can usually be - found ion the Slackware package repositories.</para> - </listitem> - <listitem> - <para>There is a <link linkend="kde4_mac_install">&MacOS;-X port</link>.</para> - </listitem> - <!-- There is no port available now - <listitem> - <para>There is a <link linkend="kde4_win_install">&Windows; port</link>.</para> - </listitem>--> - </itemizedlist></para> - - <para>Search engines - <itemizedlist> - <listitem> - <para>You can also find packages on &Linux; - software archives such as <ulink url="http://freshmeat.net/projects/krusader/">freshmeat.net</ulink>.</para> - </listitem> - <listitem> - <para>If you can not find a package for your distribution, - we recommend searching for it with - <ulink url="http://rpmfind.net/linux/rpm2html/search.php?query=krusader&submit=Search+...">rpmfind</ulink>, <ulink url="http://rpm.pbone.net/index.php3/stat/3/search/krusader">rpmpbone</ulink> or - <ulink url="http://rpmseek.com/rpm-pl/krusader.html?hl=com&cx=2155:K:0">rpmseek</ulink>.</para> - </listitem> - </itemizedlist>If you enjoy using &krusader;, we - would appreciate it if you went to one of these sites and - rated it.</para> - <para>If you still can not find a package, follow the - installation procedure on how to compile - &krusader; from source. This very thorough HowTo - describes the process in such detail that even newcomers - should not have any problems.</para> - </sect2> - <sect2 id="version_scheme"> - <title>Version Scheme</title> - <para>A new version scheme has been used since - &krusader;-1.60.0 - <itemizedlist> - <listitem> - <para>First digit - the major version</para> - </listitem> - <listitem> - <para>Second digit(s) - percentage of features completed - for this major version</para> - </listitem> - <listitem> - <para>Third digit(s) - bugfixes.</para> - </listitem> - </itemizedlist>In essence, releasing - &krusader;-1.60.0 means that we believe that - &krusader; is about 60% done with all the features - we had scheduled for the 1.x.x series. Series up to 2.4.x are - &kde; 4.x releases. 2.5.x series are the releases for &kf5-full;. Hopefully, it is easy to - understand.</para> - </sect2> - <sect2 id="krusader_stable"> - <title>Stable Version</title> - <para> - <filename>krusader-x.xx.tar.gz</filename> - </para> - <note> - <para>&krusader; is released under the - <link linkend="credits">&GNU; General Public License (GPL)</link>. This means that THE PROGRAM IS - PROVIDED "AS IS" WITH NO WARRANTY OF ANY KIND, even when it - is marked as a stable release.</para> - </note> - </sect2> - <sect2 id="krusader_devel"> - <title>Development Version (beta release)</title> - <para> - <filename>krusader-x.xx-betax.tar.gz</filename> - </para> - <para>Before every stable release we release at least one - development version in order to hunt down the bugs.</para> - <warning> - <para>These releases are beta releases and will probably - contain some bugs.</para> - </warning><note><para> - If you are using a <link linkend="krusader_devel">development</link> or - <link linkend="krusader_git">Git</link> version, it is possible that the latest - new features are not yet in the "The Krusader Handbook". - Please read the - <ulink url="https://commits.kde.org/krusader?path=ChangeLog">Changelog</ulink> - file online or in the &krusader; - sources to find out more about the new features. - For a brief description, please read the - <ulink url="https://commits.kde.org/krusader?path=NEWS">NEWS</ulink> - file online - or in the &krusader; sources. - <link linkend="faqg_wish">User feedback</link> and - <link linkend="faqg_bug_report">Bug reports</link> are always welcome! - </para></note> - <para>The beta release has 3 goals: - <itemizedlist> - <listitem> - <para>Apply a feature-freeze until the stable is released, - only bugs will be fixed. New features have to wait until - the stable is released.</para> - </listitem> - <listitem> - <para>Obtain feedback from &krusader; users so - that we can fix the bugs.</para> - </listitem> - <listitem> - <para>Give translators time to update the translations for - the coming stable release.</para> - </listitem> - </itemizedlist></para></sect2> - - <sect2 id="krusader_git"> - <title>Git</title> - - <para><ulink url="https://commits.kde.org/krusader">Git</ulink> is used for our sourcecode repository. - It is also possible to <ulink url="https://commits.kde.org/krusader?path=/">Browse the Git Repository</ulink>.</para> - <para>To check out the latest development &krusader; 2.x - for &kf5-full; from Git: - <screen><prompt>$</prompt> <userinput><command>git</command> <option>clone git://anongit.kde.org/krusader</option></userinput></screen> - </para> - </sect2> - <sect2 id="krusader_old"> - <title>Older Releases</title> - <para>If you are looking for older releases we recommend the - <ulink url="http://sourceforge.net/project/showfiles.php?group_id=6488">Sourceforge mirrors</ulink>, available from our project - page.</para> - </sect2> - </sect1> - -<sect1 id="compilation"> - <title>Krusader installation instructions</title> - <note> - <para>Please read the - <ulink url="https://commits.kde.org/krusader?path=INSTALL"><filename>INSTALL</filename></ulink> - file of the Krusader sources, it contains all latest installation instructions.</para> - </note> - - <note> - <para>From version &krusader;-2.5.0 and higher is &kf5-full; only.</para> - </note> - - <para><filename>krusader_<replaceable>version</replaceable>.tar.gz</filename> is the supposed name of the krusader tarball (it will be probably a different one ;)</para> - -<para>You can download the latest available &krusader;-2.x <link linkend="krusader_git">from Git</link>.</para> - - -<sect2> -<title>Krusader dependencies</title> -<para>The next packages are needed to run the Krusader binary.</para> -<para> - <itemizedlist> - <listitem> - <para>c libraries</para> - </listitem> - <listitem> - <para>plasma-framework libraries (&kde; Frameworks core libraries and binaries for &kf5-full; applications)</para> - </listitem> - <listitem> - <para>libqt5dbus5 (&Qt; 5 D-Bus module)</para> - </listitem> - <listitem> - <para>libqt5xml5 (&Qt; 5 &XML; module)</para> - </listitem> - <listitem> - <para>libqt5core5 (&Qt; 5 core module)</para> - </listitem> - <listitem> - <para>libqt5gui5 (&Qt; 5 &GUI; module)</para> - </listitem> - <listitem> - <para>libqt5printsupport5 (&Qt; 5 print support module)</para> - </listitem> -<!-- <listitem> - <para>libkjsembed1 (Embedded JavaScript library) - (for the optional Javascripting function in Krusader)</para> - </listitem> disabled due to KrJS does not compile (cannot find kjsembed from kdelibs --> - </itemizedlist> -</para> -</sect2> - -<sect2> -<title>Suggested packages</title> -<para>These packages are optional but they will make &krusader; much more powerful and useful.</para> - -<para>The next packages are the names that Debian/Ubuntu uses, other Linux -distros will probably use similar names.</para> -<para> - <itemizedlist> - <listitem> - <para>arj: archiver for .arj files </para> - </listitem> - <listitem> - <para>ark: graphical archiving tool by KDE</para> - </listitem> - <listitem> - <para>bzip2: high-quality block-sorting file compressor - utilities</para> - </listitem> - <listitem> - <para>cpio: GNU cpio -- a program to manage archives of files</para> - </listitem> - <listitem> - <para>kdiff3: compares and merges 2 or 3 files or directories</para> - </listitem> - <listitem> - <para>OR kompare: a KDE GUI for viewing differences between files</para> - </listitem> - <listitem> - <para>OR xxdiff: a graphical file and directories comparison and merge tool</para> - </listitem> - <listitem> - <para>kmail: KDE Email client</para> - </listitem> - <listitem> - <para>okteta: KDE hex editor</para> - </listitem> - <listitem> - <para>konsole: X terminal emulator by KDE </para> - </listitem> - <listitem> - <para>krename: Powerful batch renamer by KDE</para> - </listitem> - <listitem> - <para>lha: lzh archiver</para> - </listitem> - <listitem> - <para>md5deep: versatile file checksum creator and verifier</para> - </listitem> - <listitem> - <para>cfv: versatile file checksum creator and verifier</para> - </listitem> - <listitem> - <para>p7zip: 7zr file archiver with high compression ratio</para> - </listitem> - <listitem> - <para>rpm: Red Hat package manager</para> - </listitem> - <listitem> - <para>unace: extract, test and view .ace archives</para> - </listitem> - <listitem> - <para>unrar: Unarchiver for .rar files (non-free version)</para> - </listitem> - <listitem> - <para>OR unrar-free: Unarchiver for .rar files</para> - </listitem> - <listitem> - <para>OR rar: Archiver for .rar files</para> - </listitem> - <listitem> - <para>unzip: De-archiver for .zip files</para> - </listitem> - <listitem> - <para>zip: Archiver for .zip files</para> - </listitem> - </itemizedlist> -</para> -</sect2> - - -<sect2> -<title>Compilation requirements</title> -<para>The next packages are needed for compiling Krusader, -if you only run a Krusader binary you do not need these packages.</para> -<para> - <itemizedlist> - <listitem> - <para>gcc (The GNU C compiler)</para> - </listitem> - <listitem> - <para>g++ (The GNU C++ compiler)</para> - </listitem> - <listitem> - <para>cmake (A cross-platform, open-source make system)</para> - </listitem> - <listitem> - <para>zlib1g-dev: (library for implementing the deflate compression method found in gzip and PKZIP)</para> - </listitem> - <listitem> - <para>gettext (contains msgfmt)</para> - </listitem> - <listitem> - <para>plasma-framework-dev (installs many development libraries for &kf5;)</para> - </listitem> - <listitem> - <para>kio-dev</para> - </listitem> - - <listitem> - <para>libkf5archive-dev</para> - </listitem> - <listitem> - <para>libkf5parts-dev</para> - </listitem> - <listitem> - <para>libkf5wallet-dev</para> - </listitem> - <listitem> - <para>libkf5xmlgui-dev</para> - </listitem> - <listitem> - <para>kdoctools-dev</para> - </listitem> - </itemizedlist> -</para> -</sect2> - - - -</sect1> - -<sect1 id="kde_lin_install"> - <title>Installing on &Linux; and &BSD; platforms</title> - - <note> - <para>Please read the - <ulink url="https://commits.kde.org/krusader?path=INSTALL"><filename>INSTALL</filename></ulink> - file of the Krusader sources, it contains all latest installation instructions.</para> - </note> - - -<para><command>-DQT_INCLUDES=/usr/share/qt5/include</command> is the location of the &Qt; 5 includes</para> - -<para><command>-DCMAKE_INSTALL_PREFIX=/usr/</command> is the location where Krusader will be - installed with the make command.</para> - -<para>Another example is: <command>-DCMAKE_INSTALL_PRFIX=/opt/krusader</command> - to install the compiled Krusader in an other directory to not overwrite - the Krusader version installed by your package manager.</para> - <note> - <para> - Please use <command>sudo</command> instead of <command>su -c</command> if you are using Ubuntu-based systems. - </para> - </note> -<para> - <screen> - <prompt>$</prompt> <userinput><command>tar -xzvf</command> <option>krusader-2.5.0.tar.gz</option></userinput> - <prompt>$</prompt> <userinput><command>cd</command> <option>krusader</option></userinput> - <prompt>$</prompt> <userinput><command>mkdir</command> <option>build</option></userinput> - <prompt>$</prompt> <userinput><command>cd</command> <option>build</option></userinput> - <prompt>$</prompt> <userinput><command>cmake</command> <option>-DCMAKE_INSTALL_PREFIX=/usr/ -DQT_INCLUDES=/usr/share/qt5/include ..</option></userinput> - <prompt>$</prompt> <userinput><command>make</command></userinput> - <prompt>$</prompt> <userinput><command>su</command> <option>-c "make install"</option></userinput> - </screen> -</para> - -<para>Uninstall</para> -<para> - <screen> - <prompt>$</prompt> <userinput><command>su -c "make uninstall"</command></userinput> - </screen> -</para> - -</sect1> -<sect1 id="kde4_mac_install"> - <title>Installing on the &MacOS;-X platform</title> - - <note> - <para>Please read the - <ulink url="https://commits.kde.org/krusader?path=INSTALL"><filename>INSTALL</filename></ulink> - file of the Krusader sources, it contains all latest installation instructions.</para> - </note> - -<para>With &kde;-4 Krusader runs natively on &MacOS;-X, using its Aqua user interface (No more X11 needed!).</para> - -<para>With the help of <ulink url="http://www.macports.org/">macports.org</ulink> , &krusader; is ported to &MacOS;-X, - the port was maintained by <ulink url="https://krusader.org/developers.php">Jonas Bähr</ulink>. - A <ulink url="http://trac.macports.org/ticket/17731">portfile</ulink> is provided.</para> - -<para> - <screen> - <prompt>$</prompt> <userinput><command>sudo port install krusader</command></userinput> - </screen> -</para> - -</sect1> -<!-- -<sect1 id="kde4_win_install"> - <title>Installing on the &Windows; platform</title> - - <note> - <para>Please read the - <ulink url="https://commits.kde.org/krusader?path=INSTALL"><filename>INSTALL</filename></ulink> - file of the Krusader sources, it contains all latest installation instructions.</para> - </note> - -<para>Tested on &Windows; XP, not yet tested on &Windows; Vista but it should work.</para> - -<para>With Krusader-2.0.0 it is the first time that Krusader compiles on &Windows;, - some work needs to be done to make Krusader more usable on the &Windows; platform. - All feedback is welcome!</para> - -<para>Krusader can be compiled and installed on &Windows; with the - <ulink url="http://winkde.org/pub/kde/ports/win32/installer/">Win-KDE installer</ulink>. - See also <ulink url="http://windows.kde.org/">windows.kde.org</ulink> for more information.</para> - - </sect1>--> - - - - <sect1 id="starting-krusader"> - <title>Starting &krusader;</title> - <para>Type - <userinput> - <command>krusader</command> - </userinput> (lower case) at a command prompt. You can create - shortcut on your desktop or create an entry in the - menu. Read the previous page and the - <link linkend="faq">FAQ</link> if &krusader; does not - start.</para> - <para>When &krusader; is started from the - command line, various options can be specified to modify its - behavior.</para> - <screen> - <prompt>$</prompt> <userinput><command>krusader</command></userinput> - </screen> - <note> - <para>Do not worry about the messages you get in the - &konsole;. These messages are log messages that - can be used for debugging &krusader;.</para> - </note> - <para>You can also use - <keycombo action="simul">&Alt; - <keycap>F2</keycap></keycombo> to open the Run Command dialog - box, type - <userinput> - <command>krusader</command> - </userinput> (lower case) and press &Enter; or click - on the - <guibutton>Run</guibutton> button.</para> - <para>If &krusader; is installed by an RPM or DEB - package then usually &krusader; can be started from - the &kmenu;. Click on the - application launcher button and choose - <emphasis role="bold"> - <menuchoice> - <guimenuitem>Applications</guimenuitem> - <guimenuitem>Utilities</guimenuitem> - <guimenuitem>&krusader;</guimenuitem> - </menuchoice> - </emphasis>.</para> - <variablelist> - <title>Command-line options:</title> - <varlistentry> - <term> - <option>--left</option> - <replaceable> - <path></replaceable> - </term> - <listitem> - <para> - <action>start left panel at - <path></action> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--right</option> - <replaceable> - <path></replaceable> - </term> - <listitem> - <para> - <action>start right panel at - <path></action> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--left</option> - <replaceable> - <path1>,<path2>,<path3></replaceable> - </term> - <listitem> - <para> - <action>start left panel at - <path1>,<path2>,<path3>, - with tabs.</action> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--profile</option> - <replaceable> - <panel-profile></replaceable> - </term> - <listitem> - <para> - <action>load a - <link linkend="panel_profiles">panel-profile</link> on - startup (this overrides the - <link linkend="konfig-startup">default startup - profile</link>).</action> - </para> - </listitem> - </varlistentry> - </variablelist> - <para>Examples: - <screen><prompt>$</prompt> <userinput><command>krusader</command> <replaceable>--left=<path> --right=<path></replaceable></userinput></screen> - <screen><prompt>$</prompt> <userinput><command>krusader</command> <replaceable>--left=/mnt/cdrom --right=ftp://downlo...@myserver.net</replaceable></userinput></screen> - <screen><prompt>$</prompt> <userinput><command>krusader</command> <replaceable>--left=<path1>,<path2> --right=<path1>,<path2>,<path3></replaceable></userinput></screen> - <screen><prompt>$</prompt> <userinput><command>krusader</command> <replaceable>--profile <panel-profile></replaceable></userinput></screen> - <screen><prompt>$</prompt> <userinput><command>krusader</command> <replaceable>--profile ftp-managment</replaceable></userinput></screen> - </para> - <para>The standard &Qt; and &kf5; command-line options are available. - </para> - <variablelist> - <title>Other command-line options:</title> - <varlistentry> - <term> - <option>--author</option> - </term> - <listitem> - <para> - <action>Show the authors names</action> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--license</option> - </term> - <listitem> - <para> - <action>Show license information</action> - </para> - </listitem> - </varlistentry> - </variablelist> - </sect1> - <sect1 id="configuration"> - <title>Configuring &krusader;</title> - <para>When you run &krusader; for the first time, - the &krusader; configuration module - <link linkend="konfigurator">Konfigurator</link> will show up - and allow you to configure &krusader; as well as - detect installed packers and tools. You can always run - Konfigurator again from the - <link linkend="settings-menu">Settings menu</link>.</para> - </sect1> - <sect1 id="default-file-manager"> - <title>Making &krusader; the default file - manager</title> - <para>To make &krusader; the default file manager in - Gnome, <ulink url="http://psychocats.net/ubuntu/nonautilusplease">click here</ulink> for more information. - </para> - <para>To make &krusader; the default file manager in - &plasma;, <ulink url="https://groups.google.com/group/krusader-devel/browse_thread/thread/8209d785d3ba0ac6">click here</ulink> for more information. - </para> - </sect1> -</chapter> - diff --git a/doc/keyboard-commands.docbook b/doc/keyboard-commands.docbook index 36b72f22..153d8b5a 100644 --- a/doc/keyboard-commands.docbook +++ b/doc/keyboard-commands.docbook @@ -32,9 +32,7 @@ <link linkend="configure-shortcuts">Key-binding Profiles</link> to swap easily to other Key-binding setups, ⪚ of other commanders, or you can create your own key-bindings.</para> - <para>After - <link linkend="starting-krusader"> - starting</link> &krusader;, the keyboard action can + <para>After starting &krusader;, the keyboard action can begin. Use <keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo> to jump to the <link linkend="list_panel">Location Toolbar</link> where you can type the desired directory. After <keycombo action="simul">&Ctrl;<keycap>Down arrow</keycap></keycombo> diff --git a/doc/profiles.docbook b/doc/profiles.docbook index 6defb547..4fd9c48f 100644 --- a/doc/profiles.docbook +++ b/doc/profiles.docbook @@ -40,9 +40,7 @@ <guimenu>Window</guimenu> menu. The <link linkend="konfig-startup">default startup profile</link> will be used when starting &krusader;, but you can - override it with a - <link linkend="starting-krusader">command-line - option</link>.</para> + override it with a command-line option.</para> </sect2> <sect2 id="color_profiles"> <title>Color Profiles</title>