Gecko [ www.thearyasamaj.org ]

Name	Size	Permission
ftpasswd.html	14.61 KB	-rw-r--r--
ftpmail.html	8 KB	-rw-r--r--
ftpquota.html	10.9 KB	-rw-r--r--
index.html	9.04 KB	-rw-r--r--
mod_auth_otp.html	16.5 KB	-rw-r--r--
mod_ban.html	22.53 KB	-rw-r--r--
mod_copy.html	4.85 KB	-rw-r--r--
mod_ctrls_admin.html	15.05 KB	-rw-r--r--
mod_deflate.html	6.89 KB	-rw-r--r--
mod_digest.html	12.92 KB	-rw-r--r--
mod_dnsbl.html	6.1 KB	-rw-r--r--
mod_dynmasq.html	3.26 KB	-rw-r--r--
mod_exec.html	23.89 KB	-rw-r--r--
mod_geoip.html	17.06 KB	-rw-r--r--
mod_ifsession.html	11.02 KB	-rw-r--r--
mod_ifversion.html	4.96 KB	-rw-r--r--
mod_ldap.html	32.32 KB	-rw-r--r--
mod_load.html	2.97 KB	-rw-r--r--
mod_log_forensic.html	9.78 KB	-rw-r--r--
mod_qos.html	2.62 KB	-rw-r--r--
mod_quotatab.html	25.02 KB	-rw-r--r--
mod_quotatab_file.html	2.23 KB	-rw-r--r--
mod_quotatab_ldap.html	2.63 KB	-rw-r--r--
mod_quotatab_radius.html	2.08 KB	-rw-r--r--
mod_quotatab_sql.html	10.93 KB	-rw-r--r--
mod_radius.html	22.11 KB	-rw-r--r--
mod_ratio.html	6.99 KB	-rw-r--r--
mod_readme.html	2.69 KB	-rw-r--r--
mod_rewrite.html	30.06 KB	-rw-r--r--
mod_sftp.html	93.71 KB	-rw-r--r--
mod_sftp_pam.html	5.47 KB	-rw-r--r--
mod_sftp_sql.html	5.63 KB	-rw-r--r--
mod_shaper.html	23.28 KB	-rw-r--r--
mod_site_misc.html	5.81 KB	-rw-r--r--
mod_snmp.html	42.38 KB	-rw-r--r--
mod_sql.html	62.81 KB	-rw-r--r--
mod_sql_odbc.html	10.2 KB	-rw-r--r--
mod_sql_passwd.html	24.44 KB	-rw-r--r--
mod_sql_sqlite.html	2.95 KB	-rw-r--r--
mod_statcache.html	8.29 KB	-rw-r--r--
mod_tls.html	85.34 KB	-rw-r--r--
mod_tls_fscache.html	2.73 KB	-rw-r--r--
mod_tls_memcache.html	3.91 KB	-rw-r--r--
mod_tls_redis.html	3.6 KB	-rw-r--r--
mod_tls_shmcache.html	6.78 KB	-rw-r--r--
mod_unique_id.html	3.54 KB	-rw-r--r--
mod_wrap.html	12.38 KB	-rw-r--r--
mod_wrap2.html	24.83 KB	-rw-r--r--
mod_wrap2_file.html	4.69 KB	-rw-r--r--
mod_wrap2_redis.html	5.33 KB	-rw-r--r--
mod_wrap2_sql.html	8.33 KB	-rw-r--r--

Code Editor : mod_copy.html

<!DOCTYPE html>
<html>
<head>
<title>ProFTPD module mod_copy</title>
</head>

<hr>
<center>
<h2><b>ProFTPD module <code>mod_copy</code></b></h2>
</center>
<hr><br>

<p>
The <code>mod_copy</code> module implements <code>SITE CPFR</code>
and <code>SITE CPTO</code> commands (analogous to <code>RNFR</code> and
<code>RNTO</code>), which can be used to copy files/directories from one place
to another on the server without having to transfer the data to the client and
back.

<p>
This module is contained in the <code>mod_copy.c</code> file for
ProFTPD 1.3.<i>x</i>, and is not compiled by default.  Installation
instructions are discussed <a href="#Installation">here</a>.

<p>
The most current version of <code>mod_copy</code> is distributed with the
ProFTPD source code.

<h2>Author</h2>
<p>
Please contact TJ Saunders &lt;tj <i>at</i> castaglia.org&gt; with any
questions, concerns, or suggestions regarding this module.

<h2>Directives</h2>
<ul>
  <li><a href="#CopyEngine">CopyEngine</a>
  <li><a href="#CopyOptions">CopyOptions</a>
</ul>

<h2><code>SITE</code> Commands</h2>
<ul>
  <li><a href="#SITE_CPFR">SITE CPFR</a>
  <li><a href="#SITE_CPTO">SITE CPTO</a>
</ul>

<p>
<hr>
<h3><a name="CopyEngine">CopyEngine</a></h3>
<strong>Syntax:</strong> CopyEngine <em>on|off</em><br>
<strong>Default:</strong> CopyEngine on<br>
<strong>Context:</strong> server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code><br>
<strong>Module:</strong> mod_copy<br>
<strong>Compatibility:</strong> 1.3.6rc1 and later

<p>
The <code>CopyEngine</code> directive enables or disables the module's
handling of <code>SITE COPY</code> <i>et al</i> commands.  If it is set to
<em>off</em> this module ignores these commands.

<p>
<hr>
<h3><a name="CopyOptions">CopyOptions</a></h3>
<strong>Syntax:</strong> CopyOptions <em>opt1 ...</em><br>
<strong>Default:</strong> None<br>
<strong>Context:</strong> server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code><br>
<strong>Module:</strong> mod_copy<br>
<strong>Compatibility:</strong> 1.3.6rc3 and later

<p>
The <code>CopyOptions</code> directive is used to configure various optional
behavior of <code>mod_copy</code>.

<p>
The currently implemented options are:
<ul>
  <li><code>NoDeleteOnFailure</code><br>
    <p>
    The <code>mod_copy</code> file, when a copying operation fails, will
    delete the <i>destination</i> file by default.  If, however, you <b>do</b>
    want to keep that destination file when a failure happens, use this option.
  </li>
</ul>

<p>
<hr>
<h3><a name="SITE_CPFR">SITE CPFR</a></h3>
This <code>SITE</code> command specifies the source file/directory to use
for copying from one place to another directly on the server.

<p>
The syntax for <code>SITE CPFR</code> is:
<pre>
  SITE CPFR <i>source-path</i>
</pre>

<p>
<hr>
<h3><a name="SITE_CPTO">SITE CPTO</a></h3>
This <code>SITE</code> command specifies the destination file/directory to use
for copying from one place to another directly on the server.

<p>
The syntax for <code>SITE CPTO</code> is:
<pre>
  SITE CPTO <i>destination-path</i> 
</pre>

<p>
A client wishing to copy a file/directory first sends a <code>SITE CPFR</code>
command, then a <code>SITE CPTO</code>; this is similar to how renames are
handled using <code>RNFR</code> and <code>RNTO</code>.

<p>
Use of these <code>SITE</code> command can be controlled via
<code>&lt;Limit&gt;</code> sections, <i>e.g.</i>:
<pre>
  &lt;Limit SITE_COPY&gt;
    AllowUser alex
    DenyAll
  &lt;/Limit&gt;
</pre>

<p>
<b>Logging</b><br>
The <code>mod_copy</code> module supports <a href="../howto/Tracing.html">trace logging</a>, via the module-specific log channels:
<ul>
  <li>copy
</ul>
Thus for trace logging, to aid in debugging, you would use the following in
your <code>proftpd.conf</code>:
<pre>
  TraceLog /path/to/ftpd/trace.log
  Trace copy:20
</pre>
This trace logging can generate large files; it is intended for debugging use
only, and should be removed from any production configuration.

<hr>
<h2><a name="Installation">Installation</a></h2>
The <code>mod_copy</code> module is distributed with ProFTPD.  Simply follow
the normal steps for using third-party modules in ProFTPD.  For including
<code>mod_copy</code> as a staticly linked module:
<pre>
  $ ./configure --with-modules=mod_copy
</pre>
To build <code>mod_copy</code> as a DSO module:
<pre>
  $ ./configure --enable-dso --with-shared=mod_copy
</pre>
Then follow the usual steps:
<pre>
  $ make
  $ make install
</pre>

<p>
For those with an existing ProFTPD installation, you can use the
<code>prxs</code> tool to add <code>mod_copy</code>, as a DSO module, to
your existing server:
<pre>
  $ prxs -c -i -d mod_copy.c
</pre>

</body>
</html>

${this.title}

Code Editor : mod_copy.html