summaryrefslogtreecommitdiffstats
path: root/doc/tdeioslave/smb
diff options
context:
space:
mode:
Diffstat (limited to 'doc/tdeioslave/smb')
-rw-r--r--doc/tdeioslave/smb/CMakeLists.txt9
-rw-r--r--doc/tdeioslave/smb/Makefile.am2
-rw-r--r--doc/tdeioslave/smb/index.docbook62
3 files changed, 73 insertions, 0 deletions
diff --git a/doc/tdeioslave/smb/CMakeLists.txt b/doc/tdeioslave/smb/CMakeLists.txt
new file mode 100644
index 000000000..cb27bbf45
--- /dev/null
+++ b/doc/tdeioslave/smb/CMakeLists.txt
@@ -0,0 +1,9 @@
+#################################################
+#
+# Improvements and feedback are welcome
+#
+# This file is released under GPL >= 2
+#
+#################################################
+
+tde_create_handbook( DESTINATION tdeioslave/smb )
diff --git a/doc/tdeioslave/smb/Makefile.am b/doc/tdeioslave/smb/Makefile.am
new file mode 100644
index 000000000..11b1b83c4
--- /dev/null
+++ b/doc/tdeioslave/smb/Makefile.am
@@ -0,0 +1,2 @@
+KDE_LANG = en
+KDE_DOCS = tdeioslave/smb
diff --git a/doc/tdeioslave/smb/index.docbook b/doc/tdeioslave/smb/index.docbook
new file mode 100644
index 000000000..e3bca3f70
--- /dev/null
+++ b/doc/tdeioslave/smb/index.docbook
@@ -0,0 +1,62 @@
+<?xml version="1.0" ?>
+<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
+ <!ENTITY % addindex "IGNORE">
+ <!ENTITY % English "INCLUDE" > <!-- change language only here -->
+]>
+
+<article lang="&language;" id="smb">
+<title>SMB</title>
+<articleinfo>
+<authorgroup>
+<author>&Alexander.Neundorf; &Alexander.Neundorf.mail;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+</articleinfo>
+<para>
+The smb ioslave enables you to browse the shares of a &Windows; (or Samba)
+network.
+</para>
+
+<para>
+To see the workgroups, enter
+<userinput><command>smb:/</command></userinput>.
+</para>
+<para>
+<userinput><command>smb://</command><replaceable>a_workgroup</replaceable></userinput>
+will list the hosts in this workgroup.
+</para>
+<para>
+To see the shares of a host, enter
+<userinput><command>smb://</command><replaceable>the_host</replaceable></userinput>
+or
+<userinput><command>smb:/</command><replaceable>a_workgroup</replaceable>/<replaceable>the_host</replaceable></userinput>.
+</para>
+<para>
+To access a share directly enter
+<userinput><command>smb://</command><replaceable>the_host/the_share</replaceable></userinput>
+or
+<userinput><command>smb:/</command><replaceable>a_workgroup</replaceable>/<replaceable>the_host</replaceable>/<replaceable>the_share</replaceable></userinput>
+</para>
+
+<para>
+The smb ioslave requires that you have libsmbclient to use this ioslave.
+</para>
+
+<para>
+You can set your default user name and password in the &kcontrol; in
+<menuchoice><guisubmenu>Network</guisubmenu><guimenuitem>Windows
+Shares</guimenuitem></menuchoice>. This is especially useful if you are a
+member of a &Windows; <acronym>NT</acronym> domain. There you can also set your
+workgroup name, but in most cases this is not required. The tdeioslave will ask for your username and password if a default is not set.
+</para>
+
+<para>
+This ioslave is tested and developed using mainly Samba 2.0.7, but other
+versions of Samba should work too.
+</para>
+
+<para>
+Author: Alexander Neundorf <email>neundorf@kde.org</email>
+</para>
+</article>
+