[or-cvs] r11062: improved configuration: new and modified options and section (torflow/trunk)

[renner at seul.org]

Author: renner
Date: 2007-08-08 07:59:15 -0400 (Wed, 08 Aug 2007)
New Revision: 11062

Modified:
   torflow/trunk/pathrc.example
Log:

  improved configuration: new and modified options and sections



Modified: torflow/trunk/pathrc.example
===================================================================
--- torflow/trunk/pathrc.example	2007-08-08 11:58:13 UTC (rev 11061)
+++ torflow/trunk/pathrc.example	2007-08-08 11:59:15 UTC (rev 11062)
@@ -1,16 +1,23 @@
-[HostPort]
-# Tor Host/Port configuration
+[HOST_PORT]
+
+# Set Host and Port where Tor is
+# listening for control-connections
 control_host = 127.0.0.1
 control_port = 9051
 
-[CircuitManagement]
-# No of idle circuits to build preemptively
+# TODO: Set control_password here?
+
+[CIRC_MANAGEMENT]
+
+# Size of the maintained pool of circuits
 idle_circuits = 3
 
 # TODO: Configure ports to use
 
-[NodeSelection]
-# General
+[NODE_SELECTION]
+
+# Number of hops to be used in paths and
+# a minimum-value for advertised bandwidth
 pathlen = 3
 min_bw = 1024
 
@@ -19,68 +26,93 @@
 percent_skip = 0
 use_all_exits = yes
 
-# UniformGenerator with optionally ordered exits
-# (uniform = no) means bandwidth weighted selection
+# UniformGenerator with optionally ordered exits,
+# (uniform = no) means bandwidth-weighted selection
 uniform = no
 order_exits = no
 
-# Guards
+# Make use of guard-nodes (yes|no) or a specific 
+# exit node (nickname or IDHex)
 use_guards = yes
+#use_exit = xy
 
-# Use a specific exit node
-#use_exit = commodore64
+[GEOIP]
 
-[GeoIP]
-# Use GeoIP?
+# Use GeoIP
+# yes|no
 use_geoip = yes
 
-# True, False or comment out
+# yes|no for unique|distinct countries,
+# comment out means don't care
 unique_countries = yes
 
-# Country codes for single positions
+# Set country codes for single positions
 #entry_country = DE
+# TODO: middle_country
 #exit_country = US
 
-# 0-n or comment out
+# Maximum number of continent-crossings 
+# in generated paths: 0-n or comment out
+# to enforce distinct continents
 max_crossings = 1
 
 # TODO: excludes = ["FR"]
+# TODO: echelon = yes|no
 
+[TESTING]
+
+# Testing mode: Close every circuit after testing
+# yes|no
+testing_mode = no
+
+# Number of latency-tests per circuit (int: 0-n)
+num_rtt_tests = 5
+
+# TODO: num_bw_tests
+
+# Amount of circuits to test (int)
+num_records = 300
+
 [RTT]
-# Measure complete circuits
-measure_circs = no
 
+# Measure latencies of complete circuits
+# yes|no
+measure_circs = yes
+
 # Tor socks-properties
 socks_host = 127.0.0.1
 socks_port = 9050
-# Any ideas/proposals?
+
+# Host and port dummies to be used 
+# for ping-connections
 ping_dummy_host = 127.0.0.1
 ping_dummy_port = 100
 
-# Sleep interval between working each ping in sec
+# Time interval to wait before triggering
+# pings and frequency in seconds (float)
 initial_interval = 10
-sleep_interval = 3
-# Close circ after n timeouts
-# Set to 0 to don't close circs
+frequency = 2
+
+# Close circ after n timeouts on measurings
+# Set to 0 to not close circs (int)
 timeout_limit = 1
-# Slow RTT := x seconds, close circs slower &
-# create only circs faster than this
-slowness_limit = 0
-slow = 1.5
 
-# Set to True if we want to measure partial circuits
-# This also enables circuit creation from the model
-measure_partial_circs = no
-# Minimum number of proposals to choose from
-min_proposals = 10
-# Min ratio of traditionally created circs
-# ensures growing of the explored subnet
+[MODEL]
+
+# Set to True if you want to measure latencies of single
+# links and enable circuit creation from the model
+# yes|no
+network_model = no
+
+# RTT-threshhold when creating circuits (float):
+#   0:  no threshhold
+max_rtt = 1
+
+# Minimum number of proposals to choose from (int)
+min_proposals = 100
+
+# Min ratio of circs created with the backup-method,
+# controls growing of the model (float in [0,1])
+#   0:  no growing
+#   1:  growing only
 min_ratio = 0.5
-
-# Testing mode: Close circuits after num_tests latency-tests + 
-# involve a FileHandler to write collected data to a file
-testing_mode = no
-# Number of latency-tests per circuit
-num_tests = 5
-# Exit after collecting this number of records
-num_records = 100