FXP.One: Difference between revisions

Latest revision as of 08:01, 28 March 2018

There are further settings that will modify FXP.One's engine behavior which are not part of the definition of a site. Since we are allowed to define any variable name, which is automatically stored, some extra definitions have been created.

Since essentially Extra Site and Client Site commands are the same thing, they are separated because Extra Site lists additional commands which the FXP.One engine will act on. Where as Client Site commands are stored by clients, for clients. The FXP.One engine does not parse these key/value pairs.

USE_XDUPE
STARTDIR
FXP_TLS
IMPLICIT_TLS
LISTARGS
FEAT_CCSN
FEAT_SSCN
FEAT_PRET

Details

 USE_XDUPE=<yna>
 * Auto - If XDUPE is reported in the FEAT reply code, it will be enabled and used.
 * Yes  - Forced on, regardless of FEAT reply.
 * No   - Forced off, regardless of FEAT reply.

 STARTDIR=<str>
 * Optional extra for clients to issue CWD to <str> upon connection, instead of staying in default root "/".

 FXP_TLS=<yna>
 * Auto - Use secure (SSL) data transfers if possible, otherwise plain-text, using CCSN or SSCN.
 * Yes  - Always attempt secure (SSL) data transfers, fail if not possible.
 * No   - Do not attempt secure data transfers, always use plain-text.

The FXP_TLS option is added in addition to data_TLS as it was deemed insufficient for those who would like to force directory listings to use secure methods, but disable secure data transfers, even if sites supported such transfers. If FXP_TLS is not defined, FXP.One engine will use the default behavior as specified by data_TLS.

 IMPLICIT_TLS=<yna>
 * Auto - Do not use Implicit SSL/TLS 
 * No   - Do not use Implicit SSL/TLS
 * Yes  - Attempt implicit SSL challenge immediately upon connecting, before FTP commands.

 LISTARGS=<str>
 * Usually, FXP.Ones uses default LIST arguments ("-lL") but you can over-ride that per site by setting LISTARGS.
 * For example, LISTARGS=-sl, or even "LISTARGS= " for no arguments.

FEAT_CCSN=<str>
FEAT_SSCN=<str>
FEAT_PRET=<str>
* Allow to override the value received in reply to CCSN, SSCN, and PRET.
* If a site replies it supports SSCN, but its FTPD is faulty, you can set
* FEAT_SSCN=n to tell FXP.Oned to ignore it.

Future

 MAX_SESSIONS=<int>
 * Limit number of sessions allowed for one site. Attempts to create another session will be presented with an error.

 MAX_QUEUES=<int>
 * Limit the number of active queues a site is allowed to be involved with. When GO commands are received
 * check the total active queues, and if already over the limit, leave queue in IDLE state. Automatically start queue
 * once an active queue goes to IDLE.

@@ Line 1: / Line 1: @@
-FXP.One is a whole new system to FTP and FXP. It is not just another
+There are further settings that will modify '''FXP.One''''s engine behavior which are not part of the definition of a site. Since we are allowed to define any variable name, which is automatically stored, some extra definitions have been created.
-client. It is infact a very flexible FTP/FXP engine. This engine does
-all the hard work with dealing with FTP sites. Built into that is
-a very simple but powerful API protocol. The idea is then, if someone
-wants to do an FTP, or FXP, client they can then make one without
-the FTP hassles. Currently there already are multiple clients. They
-all talk to the FXP.One engine, and you can interchance the clients.
-That is, use one client to create and queue up some items and start the
+Since essentially '''Extra Site''' and '''Client Site''' commands are the same thing, they are separated because [[Extra Site]] lists additional commands which the '''FXP.One''' engine will act on. Where as [[Client Site]] commands are stored by clients, for clients. The '''FXP.One''' engine does not parse these key/value pairs.
-queue process. At a later time, a different client, from a different location
-can connect and check on the progress of that queue, change it, add to it and
-so on.
- The FXP.One engine features:
+* USE_XDUPE
- * Full FTP and FXP capabilities.
+* STARTDIR
- * SSL/TLS support, auto-sensing and forced.
+* FXP_TLS
- * SSL/TLS data support, auto-sensing and forced.
+* IMPLICIT_TLS
- * SSCN seceure data FXP support.
+* LISTARGS
- * CCSN seceure data FXP support.
+* FEAT_CCSN
- * XDUPE aware for faster queue processing.
+* FEAT_SSCN
- * Auto resume, or overwrite options
+* FEAT_PRET
- * Resume last (re-queue all resume items last for faster queue processing)
- * FXP direction control (if one site is firewalled)
- * PRET Pre-transfer support for ring-sites.
- * Skip lists for both files and directories
- * Pass lists for both files and directories (opposite to skip list)
- * Move-first for both files and directories
- * Automatic skip of empty files and directories.
- * Encodes all file and directory names as to handle any locale.
+==Details==
-==Getting Sources==
+  USE_XDUPE=<yna>
+  * Auto - If XDUPE is reported in the FEAT reply code, it will be enabled and used.
+  * Yes  - Forced on, regardless of FEAT reply.
+  * No   - Forced off, regardless of FEAT reply.
-[http://www.lundman.net/ftp/FXP.One-v1.0.b735.tgz FXP.One-v1.0.b735.tgz] Latest tarball.
+  STARTDIR=<str>
+  * Optional extra for clients to issue '''CWD''' to <str> upon connection, instead of staying in default root "/".
-Older versions:
+  FXP_TLS=<yna>
-[http://www.lundman.net/ftp/FXP.One-v1.0.b598.tgz FXP.One-v1.0.b598.tgz]
+  * Auto - Use secure (SSL) data transfers if possible, otherwise plain-text, using CCSN or SSCN.
+  * Yes  - Always attempt secure (SSL) data transfers, fail if not possible.
+  * No   - Do not attempt secure data transfers, always use plain-text.
+The '''FXP_TLS''' option is added in addition to '''data_TLS''' as it was deemed insufficient for those who would like to force directory listings to use secure methods, but disable secure data transfers, even if sites supported such transfers. If '''FXP_TLS''' is not defined, '''FXP.One''' engine will use the default behavior as specified by '''data_TLS'''.
+  IMPLICIT_TLS=<yna>
+  * Auto - Do not use Implicit SSL/TLS
+  * No   - Do not use Implicit SSL/TLS
+  * Yes  - Attempt implicit SSL challenge immediately upon connecting, before FTP commands.
-[[CVS]] Use CVS for cutting-edge version.
-[[Compile]] FXP.One
+  LISTARGS=<str>
+  * Usually, FXP.Ones uses default LIST arguments ("-lL") but you can over-ride that per site by setting LISTARGS.
+  * For example, LISTARGS=-sl, or even "LISTARGS= " for no arguments.
-[http://www.lundman.net/unix/FXP.One_commitlog.txt Changelog]
+ FEAT_CCSN=<str>
+ FEAT_SSCN=<str>
+ FEAT_PRET=<str>
+ * Allow to override the value received in reply to CCSN, SSCN, and PRET.
+ * If a site replies it supports SSCN, but its FTPD is faulty, you can set
+ * FEAT_SSCN=n to tell FXP.Oned to ignore it.
-==Known Clients==
-[http://www.lundman.net/wiki/index.php/Compile#The_FXP.One_clients Clients]
+=== Future ===
+  MAX_SESSIONS=<int>
+  * Limit number of sessions allowed for one site. Attempts to create another session will be presented with an error.
+  MAX_QUEUES=<int>
-==General tech specs==
+  * Limit the number of '''active queues''' a site is allowed to be involved with. When '''GO''' commands are received
+  * check the total active queues, and if already over the limit, leave queue in IDLE state. Automatically start queue
-[[Error Codes]] For Protocol error codes and definitions.
+  * once an active queue goes to IDLE.
-[[YNA Type]] Yes, No and Auto type
-[[Encoding]] The directory and file encoding scheme used.
-[[Site Definition]] Current SITE definition and its members.
-[[Extra Site]] members also understood by the engine.
-[[Client Site]] recommendations.
-==API COMMANDS==
-[[Protocol]] definition and specifications.
-== Local tranfsers ==
-[[FXPOne:local|local]]
-== Help ==
-[[FXPOne|FAQ]]