summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README168
1 files changed, 168 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..4fa224f
--- /dev/null
+++ b/README
@@ -0,0 +1,168 @@
+Smb4K README (version 0.9.x)
+============================
+
+Smb4K is an SMB/CIFS share browser for KDE. It uses the Samba software suite to
+access the SMB/CIFS shares of the local network neighborhood. Its purpose is to
+provide a program that's easy to use and has as many features as possible.
+
+Features:
+---------
+- Scanning for (active) workgroups, hosts, and shares
+- Mounting and unmounting of SMB/CIFS shares, including unmounting all shares
+ at once
+- Access to the files of a mounted SMB/CIFS share using Konqueror
+- Auto-detection of external mounts/unmounts
+- Mounting of recently used shares on start-up
+- Miscellaneous infos about the SMB/CIFS shares
+- Network search
+- WINS server support
+- Preview of SMB/CIFS shares
+- Selectable look-up and search methods
+- Default login
+- Ability to execute mount and umount SUID root
+- Special handling of homes shares
+- Ability to bookmark favorite shares
+- System tray icon
+- Support of advanced Samba options
+- Support of printer shares
+- Konqueror plugin
+- KWallet support
+- Synchronization of a remote share with a local copy and vice versa
+- Ability to define custom options for individual servers and shares
+
+Translations:
+-------------
+For the list of currently supported translations please visit Smb4K's home page
+at http://smb4k.berlios.de/information.html.
+
+Supported operating systems:
+----------------------------
+Smb4K officially supports Linux (kernel >= 2.2.x) and since version 0.4.1 also
+FreeBSD (>= 4.10-RELEASE). Smb4K might also run on other operating system (e.g.
+Solaris).
+
+Requirements:
+-------------
+This version of Smb4K depends on the development files of the following
+libraries:
+- KDE Libs & Base (>= 3.3.0): The powerful Open Source graphical desktop
+ environment for Unix workstations [http://www.kde.org]
+- Qt (>= 3.3.0): A multiplatform C++ application development framework.
+ [http://www.trolltech.no]
+- X.org or XFree86 - Freely redistributable implementations of the X Window
+ System [http://www.x.org or http://www.xfree86.org]
+- An implementation of the C library
+
+Make sure that you also have installed all header files of the libraries Qt
+and KDE are depending on. Recent versions of automake and autoconf are also
+needed.
+
+For a proper operation, you implicitly need:
+- Support of the /proc filesystem compiled into your kernel if you are using
+ Linux
+- A sh-compatible shell (bash, dash, ash, etc.) with an existing link /bin/sh
+ or the sh shell itself.
+- Samba (3.x) - Tools to access to a server's filespace and printers via
+ SMB [http://www.samba.org]
+- grep - GNU grep [http://www.gnu.org/directory/grep.html]
+- GNU awk (GAWK) or similar - A pattern scanning and processing language.
+ [http://www.gnu.org/directory/gawk.html]
+- sed - The GNU stream editor [http://www.gnu.org/directory/sed.html]
+- findutils (xargs) - The GNU Find Utilities are the basic directory searching
+ utilities of the GNU operating system
+ [http://www.gnu.org/directory/findutils.html]
+- util-linux (mount, umount) - Miscellaneous system utilities
+ [ftp://ftp.kernel.org/pub/linux/utils/util-linux]
+
+To enable full functionality, you may also want to install these packages:
+- super or sudo - Programs to allow general users to do superuser things
+ [ftp://ftp.ucolick.org/pub/users/will/ or http://www.sudo.ws/sudo/]
+- teTeX or similar (dvips) - A TeX distribution for Unix
+ [http://tug.org/teTeX/]
+- GNU enscript - A tool to convert ASCII files to PostScript
+ [http://people.ssh.fi/mtr/genscript/]
+- rsync - A file transfer program to keep (remote) files in sync
+ [http://rsync.samba.org/]
+
+Compilation and Installation
+----------------------------
+(a) Full installation:
+
+1. Change into the root directory of the source code:
+ $ cd smb4k-x.x.x
+ (Replace x.x.x with the version number)
+2. Configure the source code with at least the following command
+ $ ./configure --prefix=`kde-config --prefix`
+ Several more options can be added. Run
+ $ ./configure --help
+ to find out which ones are available.
+3. Compile the source code:
+ $ make
+4. Install the application. For that, become root
+ $ su
+ and run
+ $ make install
+ in the root directory of the source code. If you want to be able to
+ remove Smb4K with your package manager, install the 'checkinstall'
+ package and run
+ $ checkinstall
+ instead.
+
+(b) Installation without Konqueror plugin:
+
+Those of you, who do not use KDE or who do not wish to install the Konqueror
+plugin, should run this configure command
+ $ ./configure --prefix=`kde-config --prefix` --without-konqplugin
+instead of the one mentioned above and else proceed as described.
+
+Additional information about compiling and installing the software is available
+in the INSTALL file.
+
+Debugging the Source Code
+-------------------------
+If you experience crashes or similar and want to debug the source code yourself,
+compile the source code with debugging symbols. The procedure is similar to the
+one described in the "Compilation and Installation" section above except that
+you need to modify the configure command slightly:
+ $ ./configure --prefix=`kde-config --prefix` --enable-debug=full
+Now compile and install the program as stated above. If you do not want to
+install but only debug the newly compiled program, you may execute Smb4K from
+within the source code directory. Change into the 'smb4k' subdirectory and run:
+ $ ./smb4k --nofork
+If you found the cause for a bug, please let us know. A backtrace or a patch
+will be much appreciated.
+
+Help and Support
+----------------
+If you encounter problems when using Smb4K and need help or support, please
+read the 'Trouble Shooting' section of the handbook first. You can access the
+handbook from the 'Help' menu by selecting the 'Smb4K Handbook' entry or by
+pressing the F1 key. An online version handbook is also available at
+http://smb4k.berlios.de/handbook/index.html. Most of the common problems that
+arise when working with Smb4K are already covered there. If that's not the
+case, we recommend that you contact the Smb4K-general mailing list at
+https://lists.berlios.de/mailman/listinfo/smb4k-general to get help. Some of
+the developers and many users are subscribed and can help.
+
+Bugs
+----
+You are strongly encouraged to send a bug report to
+http://developer.berlios.de/bugs/?group_id=769, if you find a problem. Please
+do not forget to include information about the version of Smb4K and the
+operating system you are using (Linux or FreeBSD). It might also help if you
+mention the distribution you have installed (Linux).
+If you experienced a crash, we would appreciate if you sent us the backtrace,
+i.e. the output provided by KDE's crash dialog. Please see the section "Debug-
+ging the Source Code" for a description how to make sure useful debugging output
+is returned.
+
+Copyright
+---------
+Smb4K is released under the terms of the GNU General Public License (GPL),
+version 2. A copy of the license is available in the file COPYING.
+
+Latest Version
+--------------
+The latest stable version of Smb4K is always available from the Smb4K home page
+at http://smb4k.berlios.de.
+