Smb4K – Samba (SMB) share advanced browser
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README 6.9KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. Smb4K README (version 0.9.x)
  2. ============================
  3. Smb4K is an SMB/CIFS share browser for KDE. It uses the Samba software suite to
  4. access the SMB/CIFS shares of the local network neighborhood. Its purpose is to
  5. provide a program that's easy to use and has as many features as possible.
  6. Features:
  7. ---------
  8. - Scanning for (active) workgroups, hosts, and shares
  9. - Mounting and unmounting of SMB/CIFS shares, including unmounting all shares
  10. at once
  11. - Access to the files of a mounted SMB/CIFS share using Konqueror
  12. - Auto-detection of external mounts/unmounts
  13. - Mounting of recently used shares on start-up
  14. - Miscellaneous infos about the SMB/CIFS shares
  15. - Network search
  16. - WINS server support
  17. - Preview of SMB/CIFS shares
  18. - Selectable look-up and search methods
  19. - Default login
  20. - Ability to execute mount and umount SUID root
  21. - Special handling of homes shares
  22. - Ability to bookmark favorite shares
  23. - System tray icon
  24. - Support of advanced Samba options
  25. - Support of printer shares
  26. - Konqueror plugin
  27. - TDEWallet support
  28. - Synchronization of a remote share with a local copy and vice versa
  29. - Ability to define custom options for individual servers and shares
  30. Translations:
  31. -------------
  32. For the list of currently supported translations please visit Smb4K's home page
  33. at http://smb4k.berlios.de/information.html.
  34. Supported operating systems:
  35. ----------------------------
  36. Smb4K officially supports Linux (kernel >= 2.2.x) and since version 0.4.1 also
  37. FreeBSD (>= 4.10-RELEASE). Smb4K might also run on other operating system (e.g.
  38. Solaris).
  39. Requirements:
  40. -------------
  41. This version of Smb4K depends on the development files of the following
  42. libraries:
  43. - KDE Libs & Base (>= 3.3.0): The powerful Open Source graphical desktop
  44. environment for Unix workstations [http://www.kde.org]
  45. - Qt (>= 3.3.0): A multiplatform C++ application development framework.
  46. [http://www.trolltech.no]
  47. - X.org or XFree86 - Freely redistributable implementations of the X Window
  48. System [http://www.x.org or http://www.xfree86.org]
  49. - An implementation of the C library
  50. Make sure that you also have installed all header files of the libraries Qt
  51. and KDE are depending on. Recent versions of automake and autoconf are also
  52. needed.
  53. For a proper operation, you implicitly need:
  54. - Support of the /proc filesystem compiled into your kernel if you are using
  55. Linux
  56. - A sh-compatible shell (bash, dash, ash, etc.) with an existing link /bin/sh
  57. or the sh shell itself.
  58. - Samba (3.x) - Tools to access to a server's filespace and printers via
  59. SMB [http://www.samba.org]
  60. - grep - GNU grep [http://www.gnu.org/directory/grep.html]
  61. - GNU awk (GAWK) or similar - A pattern scanning and processing language.
  62. [http://www.gnu.org/directory/gawk.html]
  63. - sed - The GNU stream editor [http://www.gnu.org/directory/sed.html]
  64. - findutils (xargs) - The GNU Find Utilities are the basic directory searching
  65. utilities of the GNU operating system
  66. [http://www.gnu.org/directory/findutils.html]
  67. - util-linux (mount, umount) - Miscellaneous system utilities
  68. [ftp://ftp.kernel.org/pub/linux/utils/util-linux]
  69. To enable full functionality, you may also want to install these packages:
  70. - super or sudo - Programs to allow general users to do superuser things
  71. [ftp://ftp.ucolick.org/pub/users/will/ or http://www.sudo.ws/sudo/]
  72. - teTeX or similar (dvips) - A TeX distribution for Unix
  73. [http://tug.org/teTeX/]
  74. - GNU enscript - A tool to convert ASCII files to PostScript
  75. [http://people.ssh.fi/mtr/genscript/]
  76. - rsync - A file transfer program to keep (remote) files in sync
  77. [http://rsync.samba.org/]
  78. Compilation and Installation
  79. ----------------------------
  80. (a) Full installation:
  81. 1. Change into the root directory of the source code:
  82. $ cd smb4k-x.x.x
  83. (Replace x.x.x with the version number)
  84. 2. Configure the source code with at least the following command
  85. $ ./configure --prefix=`tde-config --prefix`
  86. Several more options can be added. Run
  87. $ ./configure --help
  88. to find out which ones are available.
  89. 3. Compile the source code:
  90. $ make
  91. 4. Install the application. For that, become root
  92. $ su
  93. and run
  94. $ make install
  95. in the root directory of the source code. If you want to be able to
  96. remove Smb4K with your package manager, install the 'checkinstall'
  97. package and run
  98. $ checkinstall
  99. instead.
  100. (b) Installation without Konqueror plugin:
  101. Those of you, who do not use KDE or who do not wish to install the Konqueror
  102. plugin, should run this configure command
  103. $ ./configure --prefix=`tde-config --prefix` --without-konqplugin
  104. instead of the one mentioned above and else proceed as described.
  105. Additional information about compiling and installing the software is available
  106. in the INSTALL file.
  107. Debugging the Source Code
  108. -------------------------
  109. If you experience crashes or similar and want to debug the source code yourself,
  110. compile the source code with debugging symbols. The procedure is similar to the
  111. one described in the "Compilation and Installation" section above except that
  112. you need to modify the configure command slightly:
  113. $ ./configure --prefix=`tde-config --prefix` --enable-debug=full
  114. Now compile and install the program as stated above. If you do not want to
  115. install but only debug the newly compiled program, you may execute Smb4K from
  116. within the source code directory. Change into the 'smb4k' subdirectory and run:
  117. $ ./smb4k --nofork
  118. If you found the cause for a bug, please let us know. A backtrace or a patch
  119. will be much appreciated.
  120. Help and Support
  121. ----------------
  122. If you encounter problems when using Smb4K and need help or support, please
  123. read the 'Trouble Shooting' section of the handbook first. You can access the
  124. handbook from the 'Help' menu by selecting the 'Smb4K Handbook' entry or by
  125. pressing the F1 key. An online version handbook is also available at
  126. http://smb4k.berlios.de/handbook/index.html. Most of the common problems that
  127. arise when working with Smb4K are already covered there. If that's not the
  128. case, we recommend that you contact the Smb4K-general mailing list at
  129. https://lists.berlios.de/mailman/listinfo/smb4k-general to get help. Some of
  130. the developers and many users are subscribed and can help.
  131. Bugs
  132. ----
  133. You are strongly encouraged to send a bug report to
  134. http://developer.berlios.de/bugs/?group_id=769, if you find a problem. Please
  135. do not forget to include information about the version of Smb4K and the
  136. operating system you are using (Linux or FreeBSD). It might also help if you
  137. mention the distribution you have installed (Linux).
  138. If you experienced a crash, we would appreciate if you sent us the backtrace,
  139. i.e. the output provided by KDE's crash dialog. Please see the section "Debug-
  140. ging the Source Code" for a description how to make sure useful debugging output
  141. is returned.
  142. Copyright
  143. ---------
  144. Smb4K is released under the terms of the GNU General Public License (GPL),
  145. version 2. A copy of the license is available in the file COPYING.
  146. Latest Version
  147. --------------
  148. The latest stable version of Smb4K is always available from the Smb4K home page
  149. at http://smb4k.berlios.de.