TWiki Home TWiki . Main . CLO ( vs. r1.1) TWiki webs:
BG| DE | ES | FI | FR | Glossary | HU | IT | JA | Know | Main | NL | PT | Pub | RU | SL | TWiki | Test | ZH-CN? | ZH-TW? |
Main . { Home | Users | Groups | Offices | Changes | Index | Search | Go }
 <<O>>  Difference Topic CLO (r1.1 - 23 Jan 2002 - IanClarke)
Added:
>
>

%META:TOPICINFO{author="IanClarke" date="1011809520" format="1.0" version="1.1"}% %META:TOPICPARENT{name="Documentation"}%

Freenet Reference Daemon Documentation


This manual was automatically generated by the --manual switch (see below) on Jan 23, 2002 9:56:47 AM.

Command line switches:


Name:help   (--help | -h)
Arguments: 
Default val: 
Description:   prints this help message.

Name:system   (--system)
Arguments: 
Default val: 
Description:   prints JVM properties.

Name:version   (--version | -v)
Arguments: 
Default val: 
Description:   prints out version info.

Name:manual   (--manual)
Arguments: 
Default val: 
Description:   prints a manual in HTML.

Name:export   (--export | -x)
Arguments:<file>|-
Default val:-
Description:   exports a signed NodeReference?.

Name:seed   (--seed | -s)
Arguments:<file>|-
Default val:-
Description:   seeds routing table with refs.

Name:config   (--config | -c)
Arguments:<file>
Default val:freenet.conf
Description:   generates or updates config file.

Name:paramFile   (--paramFile | -p)
Arguments:<file>
Default val: 
Description:   path to a config file in a non-default location.

Configuration options:

These can reside either in the configuration file or be given as command line arguments.
Name:ipAddress   (--ipAddress)
Arguments:xxx.xxx.xxx.xxx
Default val:
Description:   The IP address of this node as seen by the public internet. This is needed in order for the node to determine its own node reference. If you have a dynamic IP address, you may enter a host name in this field (assuming you have a dynamic DNS service). If this is a transient node, you can leave this blank.

Name:listenPort   (--listenPort)
Arguments:<port no.>
Default val:62680
Description:   The port to listen for incoming FNP (Freenet Node Protocol) connections on.

Name:clientPort   (--clientPort)
Arguments:<port no.>
Default val:8481
Description:   The port to listen for local FCP (Freenet Client Protocol) connections on.

Name:fcpHosts   (--fcpHosts)
Arguments:<host list>
Default val:
Description:   A comma-separated list of hosts that may connect to the FCP port (clientPort). If left blank, only the localhost will be allowed. May be given as IP addresses or host names.

Name:adminPassword   (--adminPassword)
Arguments:<string>
Default val: 
Description:   If this is set then users that can provide the password can can have administrative access. It is recommended that you do not use this without also using adminPeer below in which case both are required.

Name:adminPeer   (--adminPeer)
Arguments:<Identity FieldSet?>
Default val: 
Description:   If this is set, then users that are authenticated owners of the given PK identity can have administrative access. If adminPassword is also set both are required.

Name:transient   (--transient)
Arguments:yes|no
Default val:false
Description:   Transient nodes do not give out references to themselves, and should therefore not receive any requests. Set this to yes if you cannot receive incoming connections, or cannot keep the computer continuously online.

Name:doAnnounce   (--doAnnounce)
Arguments:yes|no
Default val:true
Description:   If this is true, the node will automatically announce to all nodes in the file, as specified by , etc.

Name:seedFile   (--seedFile)
Arguments:<file>
Default val:seednodes.ref
Description:   A file containing one or more node references which will be incorporated into the node's routing table on startup. A reference is only added if there is no previously existing reference to that node. When this node announces, it will announce to the nodes listed in this file.

Name:doDiagnostics   (--doDiagnostics)
Arguments:yes|no
Default val:true
Description:   The diagnostics module receives and aggregates statistics about Freenet's performance. This will eat some gratuitous memory and CPU time but may let you provide valuable data to the project.

Name:diagnosticsPath   (--diagnosticsPath)
Arguments:<dir>
Default val:stats
Description:   The directory in which to save diagnostics data. Defaults to /stats if left blank.

Name:nodeFile   (--nodeFile)
Arguments:<file>
Default val:
Description:   The path to the file containing the node's private key, DSA group, cipher key, etc. Defaults to node_ in the current directory.

Name:storeFile   (--storeFile)
Arguments:<file>[,..]
Default val:
Description:   The path to a single file, or a comma-separated list of files, containing the data store. The size of each file is given by .

Name:storeSize   (--storeSize)
Arguments:<bytes>
Default val:209715200
Description:   The byte size of each data store file. If there is more than one file, the total size of the store is the product of the number of files and .

Name:storeCipherName   (--storeCipherName)
Arguments:<string>
Default val:Twofish
Description:   The name of a symmetric cipher algorithm to encrypt the datastore contents with. Supported algorithms are "Twofish", "Rijndael", and "null", "none", or "void" (for no encryption).

Name:storeCipherWidth   (--storeCipherWidth)
Arguments:<integer>
Default val:128
Description:   The width in bits of the cipher key to use for the datastore. The allowed values for this will depend on the cipher algorithm. Twofish allows 64, 128, 192, or 256, while Rijndael allows 128, 192, or 256.

Name:bandwidthLimit   (--bandwidthLimit)
Arguments:<bytes/sec>
Default val:100000
Description:   The maximum number of bytes per second to transmit, totaled between incoming and outgoing connections. Ignored if either inputBandwidthLimit or outputBandwidthLimit is nonzero.

Name:inputBandwidthLimit   (--inputBandwidthLimit)
Arguments:<bytes/sec>
Default val:0
Description:   If nonzero, specifies an independent limit for incoming data only. (overrides bandwidthLimit if nonzero)

Name:outputBandwidthLimit   (--outputBandwidthLimit)
Arguments:<bytes/sec>
Default val:0
Description:   If nonzero, specifies an independent limit for outgoing data only. (overrides bandwidthLimit if nonzero)

Name:maxNodeConnections   (--maxNodeConnections)
Arguments:<int>
Default val:60
Description:   The maximum number of incoming and outgoing connections to allow at the same time.

Name:logLevel   (--logLevel)
Arguments:<word>
Default val:normal
Description:   The error reporting threshold, one of: Error: Errors only Normal: Report significant events Minor: Report minor events Debug: Report events only of relevance when debugging

Name:logFile   (--logFile)
Arguments:<filename>|NO
Default val:freenet.log
Description:   The name of the log file (`NO' to log to standard out)

Name:logFormat   (--logFormat)
Arguments:<tmpl.>
Default val:d (c, t): m
Description:   A template string for log messages. All non-alphabet characters are reproduced verbatim. Alphabet characters are substituted as follows: d = date (timestamp), c = class name of the source object, h = hashcode of the object, t = thread name, p = priority, m = the actual log message

Name:logDate   (--logDate)
Arguments:<tmpl.>
Default val:
Description:   A template for formatting the timestamp in log messages. Defaults to the locale specific fully specified date format. The template string is an ordinary Java date/time template - see: http://java.sun.com/products/jdk/1.1/docs/api/java.text.SimpleDateFormat.html

Name:rtMaxRefs   (--rtMaxRefs)
Arguments:<integer>
Default val:100
Description:   The number of references allowed per node in the routing table. This should not be set too high.

Name:rtMaxNodes   (--rtMaxNodes)
Arguments:<integer>
Default val:100
Description:   The number of unique nodes that can be contained in the routing table.

Name:messageStoreSize   (--messageStoreSize)
Arguments:<integer>
Default val:500
Description:   The number of outstanding message replies the node will wait for before it starts to abandon them.

Name:routeConnectTimeout   (--routeConnectTimeout)
Arguments:<millis>
Default val:10000
Description:   The time to wait for connections to be established and authenticated before passing by a node while routing out. Connections that are by passed are still finished and cached for the time set by (in milliseconds).

Name:maxHopsToLive   (--maxHopsToLive)
Arguments:<integer>
Default val:15
Description:   When forwarding a request, the node will reduce the HTL to this value if it is found to be in excess.

Name:announcementPeers   (--announcementPeers)
Arguments:<integer>
Default val:15
Description:   An announcement must visit announcementPeers nodes to be successful. If there is more than one seed node, announcements will be sent to them all, and the HTL of each announcement will be given by: HTL = announcementPeers / (no. of seed nodes)

Name:announcementAttempts   (--announcementAttempts)
Arguments:<integer>
Default val:10
Description:   The number of attempts to make at announcing this node per initial peer. Zero means the node will not announce itself

Name:announcementDelay   (--announcementDelay)
Arguments:<integer>
Default val:1800000
Description:   The amount of time to wait before initially announcing the node, and to base the time the time between retries on. In milliseconds.

Name:announcementDelayBase   (--announcementDelayBase)
Arguments:<integer>
Default val:2
Description:   The value to mutliply the last delay time with for each retry. That is, for try N, we weight *^N before starting.

Name:initialRequests   (--initialRequests)
Arguments:<integer>
Default val:10
Description:   The number of keys to request from the returned close values after an Announcement (this is per announcement made).

Name:initialRequestHTL   (--initialRequestHTL)
Arguments:<integer>
Default val:15
Description:   The hops that initial requests should make.

Name:fproxy.class   (--fproxy.class)
Arguments:<class name>
Default val:freenet.client.http.FproxyServlet
Description:   The Java class for the fproxy HttpServlet?. You shouldn't need to change this.

Name:fproxy.port   (--fproxy.port)
Arguments:<port number>
Default val:8888
Description:   The port that fproxy listens for HTTP requests on.

Name:fproxy.params.insertHtl   (--fproxy.params.insertHtl)
Arguments:n
Default val:5
Description:   The default htl used when inserting via fproxy.

Name:fproxy.params.requestHtl   (--fproxy.params.requestHtl)
Arguments:n
Default val:15
Description:   The default htl used when requesting via fproxy.

Name:fproxy.params.passThroughMimeTypes   (--fproxy.params.passThroughMimeTypes)
Arguments:<list>
Default val:text/plain,image/jpeg,image/gif,image/png
Description:   A comma delimited list of mime types that are allowed by fproxy's anonymity filter code.

Name:fproxy.params.filter   (--fproxy.params.filter)
Arguments:true/false
Default val:true
Description:   Set true to enable fproxy's anonymity protection filtering.

Name:fproxy.params.splitFileThreads   (--fproxy.params.splitFileThreads)
Arguments:n
Default val:5
Description:   Maximum number of threads per SplitFile? request.

Name:fproxy.params.splitFileRetries   (--fproxy.params.splitFileRetries)
Arguments:n
Default val:0
Description:   Number of times to retry failed SplitFile? block requests.

Name:fproxy.params.splitFileRetryHtlIncrement   (--fproxy.params.splitFileRetryHtlIncrement)
Arguments:n
Default val:5
Description:   Amount to increment SplitFile? request htl each retry.

Name:fproxy.params.pollForDroppedConnection   (--fproxy.params.pollForDroppedConnection)
Arguments:true/false
Default val:true
Description:   Set true to allow polling for dropped requests during SplitFile? download.

Name:services   (--services)
Arguments:service_0,service_1,...
Default val:fproxy,nodestatus
Description:   A comma delimited list of services that are run when the node starts. Enter 'fproxy' here to start fproxy automatically.

Name:nodestatus.class   (--nodestatus.class)
Arguments:<class name>
Default val:freenet.client.http.NodeStatusServlet
Description:   The Java class for the NodeStatusServlet?. You shouldn't need to change this.

Name:nodestatus.port   (--nodestatus.port)
Arguments:<port number>
Default val:8889
Description:   The port that the node status servlet listens for HTTP requests on.

Name:authTimeout   (--authTimeout)
Arguments:<millis>
Default val:30000
Description:   How long to wait for authentication before giving up (in milliseconds)

Name:connectionTimeout   (--connectionTimeout)
Arguments:<millis>
Default val:15000
Description:   How long to listen on an inactive connection before closing (if reply address is known)

Name:hopTimeExpected   (--hopTimeExpected)
Arguments:<millis>
Default val:12000
Description:   The expected time it takes a Freenet node to pass a message. Used to calculate timeout values for requests.

Name:hopTimeDeviation   (--hopTimeDeviation)
Arguments:<millis>
Default val:12000
Description:   The expected standard deviation in hopTimeExpected.

Name:maximumThreads   (--maximumThreads)
Arguments:<integer>
Default val:120
Description:   Should we use thread management? If this number is defined and non-zero, this specifies the max number of threads in the pool. If this is overrun connections will be rejected and events won't execute on time.

Name:blockSize   (--blockSize)
Arguments:<bytes>
Default val:4096
Description:   What size should the blocks have when moving data?

Name:streamBufferSize   (--streamBufferSize)
Arguments:<bytes>
Default val:65536
Description:   The default size of stream buffers.

Name:maximumPadding   (--maximumPadding)
Arguments:<bytes>
Default val:65536
Description:   The maximum number of bytes of padding to allow between messages and in Void messages.

Name:logInboundContacts   (--logInboundContacts)
Arguments:true/false
Default val:false
Description:   Set true to enable inbound contact monitoring.

Name:logOutboundContacts   (--logOutboundContacts)
Arguments:true/false
Default val:false
Description:   Set true to enable outbound contact monitoring.

Name:logInboundRequests   (--logInboundRequests)
Arguments:true/false
Default val:false
Description:   Set true to enable per host inbound request monitoring.

Name:localAnnounceTargets   (--localAnnounceTargets)
Arguments:<list>
Default val: 
Description:   Used only in debugging.


Topic CLO . { View | Diffs | r1.1 | More }
Revision -
Revision r1.1 - 23 Jan 2002 - 18:12 GMT - IanClarke
This website is distributed under the GNU Documentation License