From ac4107ceea994f028ae67b43dbe6676b9ccf2b3b Mon Sep 17 00:00:00 2001
From: tmanevik <tommy.manevik@combitech.se>
Date: Thu, 19 Mar 2015 14:00:43 +0100
Subject: Editorial updates

SSH application
---
 lib/ssh/doc/src/ssh_sftpd.xml | 56 ++++++++++++++++++++++++-------------------
 1 file changed, 31 insertions(+), 25 deletions(-)

(limited to 'lib/ssh/doc/src/ssh_sftpd.xml')

diff --git a/lib/ssh/doc/src/ssh_sftpd.xml b/lib/ssh/doc/src/ssh_sftpd.xml
index 81c2acc575..bc2660f595 100644
--- a/lib/ssh/doc/src/ssh_sftpd.xml
+++ b/lib/ssh/doc/src/ssh_sftpd.xml
@@ -22,67 +22,73 @@
     </legalnotice>
 
     <title>ssh_sftpd</title>
+    <prepared></prepared>
+    <docno></docno>
     <date>2005-09-22</date>
+    <rev></rev>
     <file>ssh_sftpd.sgml</file>
   </header>
   <module>ssh_sftpd</module>
-  <modulesummary>Specifies the channel process to handle an sftp subsystem.</modulesummary>
+  <modulesummary>Specifies the channel process to handle an SFTP subsystem.</modulesummary>
   <description>
-    <p>Specifies a channel process to handle a sftp subsystem.</p>
+    <p>Specifies a channel process to handle an SFTP subsystem.</p>
   </description>
 
   <section>
-    <title>DATA TYPES </title>
-    <p><c>subsystem_spec() = {subsystem_name(), {channel_callback(), channel_init_args()}} </c></p>
-    <p><c>subsystem_name() =  "sftp"</c></p>
-    <p><c>channel_callback() = atom()</c> - Name of the erlang module implementing the
-    subsystem using the ssh_channel behavior see
-    <seealso marker="ssh_channel">ssh_channel(3)</seealso></p>
-    <p><c> channel_init_args() = list() - The one given as argument to function
-    subsystem_spec/1.</c></p>  
+    <title>DATA TYPES</title>
+    <taglist>
+      <tag><c>subsystem_spec()</c></tag>
+      <item><p>= <c>{subsystem_name(), {channel_callback(), channel_init_args()}}</c></p></item>
+      <tag><c>subsystem_name()</c></tag>
+      <item><p>= <c>"sftp"</c></p></item>
+      <tag><c>channel_callback()</c></tag>
+      <item><p>= <c>atom()</c> - Name of the Erlang module implementing the subsystem using the
+      <c>ssh_channel</c> behavior, see the
+      <seealso marker="ssh_channel">ssh_channel(3)</seealso> manual page.</p></item>
+      <tag><c>channel_init_args()</c></tag>
+      <item><p>= <c>list()</c> - The one given as argument to function <c>subsystem_spec/1</c>.</p></item>
+    </taglist>
   </section>
   <funcs>
     <func>
       <name>subsystem_spec(Options) -> subsystem_spec()</name>
-      <fsummary>Returns the subsystem specification that allows an ssh daemon to handle the subsystem "sftp".</fsummary>
+      <fsummary>Returns the subsystem specification that allows an SSH daemon to handle the subsystem "sftp".</fsummary>
       <type>
 	<v>Options = [{Option, Value}]</v>
       </type>
       <desc>
-        <p>Should be used together with ssh:daemon/[1,2,3]</p>
-        <p>Options are:</p>
+        <p>Is to be used together with <c>ssh:daemon/[1,2,3]</c></p>
+        <p>Options:</p>
         <taglist>
           <tag><c><![CDATA[{cwd, String}]]></c></tag>
           <item>
-            <p>Sets the initial current working directory for the
-              server.</p>
+            <p>Sets the initial current working directory for the server.</p>
           </item>
           <tag><c><![CDATA[{file_handler, CallbackModule}]]></c></tag>
           <item>
 	    <p>Determines which module to call for accessing
-	    the file server. The default value is <c>ssh_sftpd_file</c> that uses the
-	    <seealso marker="kernel:file">file</seealso> and <seealso marker="stdlib:filelib">filelib</seealso> API:s to access the standard OTP file
-	    server. This option may be used to plug in
+	    the file server. The default value is <c>ssh_sftpd_file</c>, which uses the
+	    <seealso marker="kernel:file">file</seealso> and <seealso marker="stdlib:filelib">filelib</seealso>
+	    APIs to access the standard OTP file server. This option can be used to plug in
 	    other file servers.</p>
 	  </item>
 	  <tag><c><![CDATA[{max_files, Integer}]]></c></tag>
 	  <item>
 	    <p>The default value is <c>0</c>, which means that there is no upper limit.
-	    If supplied, the number of filenames returned to the sftp client per <c>READDIR</c>
+	    If supplied, the number of filenames returned to the SFTP client per <c>READDIR</c>
 	    request is limited to at most the given value.</p>
 	  </item>
 	  <tag><c><![CDATA[{root, String}]]></c></tag>
 	  <item>
-	    <p>Sets the sftp root directory. The user will then not be
-	    able to see any files above this root. If for instance
-	    the root is set to <c>/tmp</c> the user will see this
-	    directory as <c>/</c> and if the user does cd <c>/etc</c>
-	    the user will end up in <c>/tmp/etc</c>.
+	    <p>Sets the SFTP root directory. Then the user cannot see any files
+	    above this root. If, for example, the root directory is set to <c>/tmp</c>,
+	    then the user sees this directory as <c>/</c>. If the user then writes
+	    <c>cd /etc</c>, the user moves to <c>/tmp/etc</c>.
 	    </p>
 	  </item>
 	  <tag><c><![CDATA[{sftpd_vsn, integer()}]]></c></tag>
 	  <item>
-	    <p>Sets the sftp version to use, defaults to 5. Version 6 is under
+	    <p>Sets the SFTP version to use. Defaults to 5. Version 6 is under
 	    development and limited.</p>
 	  </item>
         </taglist>
-- 
cgit v1.2.3