r142 - /debtorrent/trunk/config.debtorrent.ini
camrdale-guest at users.alioth.debian.org
camrdale-guest at users.alioth.debian.org
Tue Jul 10 19:40:45 UTC 2007
Author: camrdale-guest
Date: Tue Jul 10 19:40:45 2007
New Revision: 142
URL: http://svn.debian.org/wsvn/debtorrent/?sc=1&rev=142
Log:
Cleanup the new config file.
Modified:
debtorrent/trunk/config.debtorrent.ini
Modified: debtorrent/trunk/config.debtorrent.ini
URL: http://svn.debian.org/wsvn/debtorrent/debtorrent/trunk/config.debtorrent.ini?rev=142&op=diff
==============================================================================
--- debtorrent/trunk/config.debtorrent.ini (original)
+++ debtorrent/trunk/config.debtorrent.ini Tue Jul 10 19:40:45 2007
@@ -19,33 +19,39 @@
# L O C A T I O N S
###############################################################################
#
-# config_dir
-#
-# the directory to use to get/store configuration files, if not specified then a .DebTorrent directory in the user's home directory will be used
+# Config Directory
+#
+# The directory to use to get/store configuration files, if left blank then
+# ~/.DebTorrent will be used.
#
# config_dir = "/etc/debtorrent"
#
-# cache_dir
-#
-# the directory to use to get/store cache files, if not specified then a .DebTorrent directory in the user's home directory will be used
+# Cache Directory
+#
+# The directory to use to get/store cache files, if left blank then
+# ~/.DebTorrent will be used.
#
# cache_dir = "/var/cache/debtorrent/.cache"
#
-# saveas
-#
-# local file name to save the file as, null indicates query user
+# SaveAs
+#
+# The directory to save the downloaded files in.
#
# saveas = "/var/cache/debtorrent"
#
-# saveas_style
-#
-# How to name torrent download directory (1 = <mirror>_dists_<suite>_<section>_binary-<arch>, 2 = <mirror> (caution: experimental))
+# SaveAs Style
+#
+# How to name the torrent download directories:
+# 1 -- <mirror>_dists_<suite>_<section>_binary-<arch>
+# 2 -- <mirror>
+#
+# WARNING: A SaveAs Style of 2 is experimental and may result in problems.
#
# saveas_style = 1
@@ -97,9 +103,9 @@
# max_rate_period = 20.0
#
-# upload_unit_size
-#
-# when limiting upload rate, how many bytes to send at a time
+# Upload Unit Size
+#
+# When limiting the upload rate, how many bytes to send at a time.
#
# upload_unit_size = 1460
@@ -108,81 +114,84 @@
# I N C O M I N G C O N N E C T I O N S
###############################################################################
#
-# bind
-#
-# comma-separated list of ips/hostnames to bind to locally
+# Bind
+#
+# A comma-separated list of ips and hostnames to bind to locally.
#
# bind = ""
#
-# ip
-#
-# ip to report you have to the tracker.
+# IP
+#
+# The IP to report you have to the tracker (useful for local connections).
#
# ip = ""
#
-# minport
-#
-# minimum port to listen on, counts up if unavailable
+# Minimum Port
+#
+# The minimum port to try listening on. Only one will be used.
#
# minport = 10000
#
-# maxport
-#
-# maximum port to listen on
+# Maximum Port
+#
+# The maximum port to try listening on. Only one will be used.
#
# maxport = 60000
#
-# random_port
-#
-# whether to choose randomly inside the port range instead of counting up linearly
+# Random Port
+#
+# Whether to choose randomly inside the port range instead of counting up
+# linearly.
#
# random_port = 1
#
-# ipv6_enabled
-#
-# allow the client to connect to peers via IPv6
+# IPv6 Enabled
+#
+# Allow the client to connect to peers via IPv6.
#
# ipv6_enabled = 0
#
-# ipv6_binds_v4
-#
-# set if an IPv6 server socket will also field IPv4 connections
+# IPv6 Binds v4
+#
+# Whether an IPv6 server socket will also field IPv4 connections.
#
# ipv6_binds_v4 = 0
#
-# expire_cache_data
-#
-# the number of days after which you wish to expire old cache data (0 = disabled)
+# Expire Cache Data
+#
+# The number of days after which you wish to expire old cache data
+# (0 = disabled).
#
# expire_cache_data = 10
#
-# timeout
-#
-# time to wait between closing sockets which nothing has been received on
+# Timeout
+#
+# Time to wait between closing sockets which nothing has been received on
+# (in seconds).
#
# timeout = 300.0
#
-# timeout_check_interval
-#
-# time to wait between checking if any connections have timed out
+# Timeout Check Interval
+#
+# Time to wait between checking if any connections have timed out (in seconds).
#
# timeout_check_interval = 60.0
@@ -191,41 +200,42 @@
# T R A C K E R C O N N E C T I O N S
###############################################################################
#
-# default_tracker
-#
-# the default tracker address to use for new torrents
+# Default Tracker
+#
+# The default tracker address to use for new torrents that don't specify one.
#
# default_tracker = http://dttracker.debian.net:6969/announce
#
-# rerequest_interval
-#
-# time to wait between requesting more peers
+# Rerequest Interval
+#
+# The time to wait between requesting more peers from the tracker (in seconds).
#
# rerequest_interval = 300
#
-# min_peers
-#
-# minimum number of peers to not do rerequesting
+# Min Peers
+#
+# The minimum number of peers to not do tracker rerequesting when above.
#
# min_peers = 20
#
-# max_initiate
-#
-# number of peers at which to stop initiating new connections
+# Max Initiate
+#
+# The number of peers at which to stop initiating new connections to peers.
#
# max_initiate = 40
#
-# http_timeout
-#
-# number of seconds to wait before assuming that an http connection has timed out
+# HTTP Timeout
+#
+# The number of seconds to wait before assuming that an http connection to a
+# tracker has timed out.
#
# http_timeout = 60
@@ -322,121 +332,121 @@
#
###############################################################################
#
-# max_uploads
+# Max Uploads
#
-# the maximum number of uploads to allow at once.
+# The maximum number of peers to upload to at once.
#
# max_uploads = 7
#
-# keepalive_interval
-#
-# number of seconds to pause between sending keepalives
+# KeepAlive Interval
+#
+# The number of seconds to pause between sending keepalive message to peers.
#
# keepalive_interval = 120.0
#
-# download_slice_size
-#
-# How many bytes to query for per request.
+# Download Slice Size
+#
+# The number of bytes to ask a peer for in a request.
#
# download_slice_size = 16384
#
-# request_backlog
-#
-# maximum number of requests to keep in a single pipe at once.
-#
-
-# request_backlog = 10
-
-#
-# max_message_length
-#
-# maximum length prefix encoding you'll accept over the wire - larger values get the connection dropped.
+# Maximum Message Length
+#
+# The maximum length (in bytes) prefix encoding you'll accept over the wire.
+# Larger values get the connection dropped.
#
# max_message_length = 8388608
#
-# max_slice_length
-#
-# maximum length slice to send to peers, larger requests are ignored
+# Maximum Slice Length
+#
+# The maximum length slice to send to peers, in bytes, larger requests are
+# ignored.
#
# max_slice_length = 131072
#
-# rarest_first_cutoff
-#
-# number of downloads at which to switch from random to rarest first
+# Rarest First Cutoff
+#
+# The number of downloaded pieces at which to switch from random piece
+# selection to a rarest first piece policy.
#
# rarest_first_cutoff = 2
#
-# rarest_first_priority_cutoff
-#
-# the number of peers which need to have a piece before other partials take priority over rarest first
+# Rarest First Priority Cutoff
+#
+# The number of peers which need to have a piece before completing other
+# partial pieces takes priority over the rarest first piece policy.
#
# rarest_first_priority_cutoff = 5
#
-# breakup_seed_bitfield
-#
-# sends an incomplete bitfield and then fills with have messages, in order to get around stupid ISP manipulation
+# Breakup Seed Bitfield
+#
+# Whether to send an incomplete bitfield and then fill it in with have
+# messages, instead of sending a complete (all 1's) bitfield. This is used
+# in order to get around some stupid ISP manipulations.
#
# breakup_seed_bitfield = 1
#
-# snub_time
-#
-# seconds to wait for data to come in over a connection before assuming it's semi-permanently choked
+# Snub Time
+#
+# The number of seconds to wait for data to come in over a connection before
+# assuming it's semi-permanently choked.
#
# snub_time = 30.0
#
-# min_uploads
-#
-# the number of uploads to fill out to with extra optimistic unchokes
+# Minimum Uploads
+#
+# The number of uploads to fill out to with extra optimistic unchokes.
#
# min_uploads = 4
#
-# round_robin_period
-#
-# the number of seconds between the client's switching upload targets
+# Round Robin Period
+#
+# The number of seconds between the client's switching upload targets.
#
# round_robin_period = 30
#
-# security
-#
-# whether to enable extra security features intended to prevent abuse
+# Security
+#
+# Whether to enable extra security features intended to prevent abuse.
#
# security = 1
#
-# max_connections
-#
-# the absolute maximum number of peers to connect with (0 = no limit)
+# Maximum Connections
+#
+# The absolute maximum number of peers to connect with (0 = no limit).
#
# max_connections = 0
#
-# auto_kick
-#
-# whether to allow the client to automatically kick/ban peers that send bad data
+# Auto Kick
+#
+# Whether to allow the client to automatically kick/ban peers that send bad
+# data.
#
# auto_kick = 1
@@ -445,73 +455,76 @@
# F I L E S Y S T E M
###############################################################################
#
-# buffer_reads
-#
-# whether to buffer disk reads
+# Buffer Reads
+#
+# Whether to buffer disk reads.
#
# buffer_reads = 1
#
-# write_buffer_size
-#
-# the maximum amount of space to use for buffering disk writes (in megabytes, 0 = disabled)
+# Write Buffer Size
+#
+# The maximum amount of space to use for buffering disk writes, in megabytes
+# (0 = disabled).
#
# write_buffer_size = 4
#
-# max_files_open
-#
-# the maximum number of files to keep open at a time, 0 means no limit
+# Maximum Files Open
+#
+# The maximum number of files to keep open at a time (0 = no limit).
#
# max_files_open = 50
#
-# check_hashes
-#
-# whether to check hashes on disk
+# Check Hashes
+#
+# Whether to re-check hashes of data already downloaded during startup.
#
# check_hashes = 1
#
-# double_check
-#
-# whether to double-check data being written to the disk for errors (may increase CPU load)
+# Double Check
+#
+# Whether to double-check data being written to the disk for errors (may
+# increase CPU load).
#
# double_check = 1
#
-# triple_check
-#
-# whether to thoroughly check data being written to the disk (may slow disk access)
+# Triple Check
+#
+# Whether to thoroughly check data being written to the disk (may slow disk
+# access).
#
# triple_check = 0
#
-# lock_files
-#
-# whether to lock files the client is working with
+# Lock Files
+#
+# Whether to lock files the client is working with.
#
# lock_files = 1
#
-# lock_while_reading
-#
-# whether to lock access to files being read
+# Lock While Reading
+#
+# Whether to lock access to files being read.
#
# lock_while_reading = 0
#
-# auto_flush
-#
-# minutes between automatic flushes to disk (0 = disabled)
+# Auto Flush
+#
+# The number of minutes between automatic flushes to disk (0 = disabled).
#
# auto_flush = 0
@@ -520,17 +533,18 @@
# A D V A N C E D B I T T O R R E N T S T U F F
###############################################################################
#
-# super_seeder
-#
-# whether to use special upload-efficiency-maximizing routines (only for dedicated seeds)
+# Super Seeder
+#
+# Whether to use special upload-efficiency-maximizing routines (only for
+# dedicated seeds).
#
# super_seeder = 0
#
-# dedicated_seed_id
-#
-# code to send to tracker identifying as a dedicated seed
+# Dedicated Seed ID
+#
+# The code to send to a tracker identifying this client as a dedicated seed.
#
# dedicated_seed_id = ""
@@ -539,9 +553,12 @@
# B A C K U P H T T P D O W N L O A D E R
###############################################################################
#
-# disable_http_downloader
-#
-# (for testing purposes only) whether to disable the backup HTTP downloader
+# Disable HTTP Downloader
+#
+# Whether to disable the backup HTTP downloader.
+#
+# WARNING: This may serously impact the ability of the client to find some
+# packages. It is only intended for testing purposes.
#
# disable_http_downloader = 0
@@ -550,9 +567,9 @@
# O T H E R T H I N G S
###############################################################################
#
-# display_path
-#
-# whether to display the full path or the torrent contents for each torrent
+# Display Path
+#
+# Whether to display the full path or the torrent contents for each torrent.
#
# display_path = 0
@@ -574,17 +591,18 @@
# A P T L I S T E N E R
###############################################################################
#
-# port
-#
-# port to listen for apt on
+# Port
+#
+# The port to listen for apt requests on.
#
# port = 9988
#
-# min_time_between_log_flushes
-#
-# minimum time it must have been since the last flush to do another one
+# Min Time Between Log Flushes
+#
+# The minimum time it must have been since the last log flush to do another
+# one (in seconds).
#
# min_time_between_log_flushes = 3.0
@@ -592,142 +610,105 @@
#
# dfile
#
-# file to store recent apt downloader info in
+# The file to store recent apt downloader state in.
#
# dfile = ""
#
-# socket_timeout
-#
-# timeout for closing connections
-#
-
-# socket_timeout = 15
-
-#
-# save_dfile_interval
-#
-# seconds between saving dfile
+# Save dfile Interval
+#
+# The number of seconds between saving the dfile.
#
# save_dfile_interval = 300
#
-# min_time_between_log_flushes
-#
-# minimum time it must have been since the last flush to do another one
-#
-
-# min_time_between_log_flushes = 3.0
-
-#
-# min_time_between_cache_refreshes
-#
-# minimum time in seconds before a cache is considered stale and is flushed
-#
-
-# min_time_between_cache_refreshes = 600.0
-
-#
-# allowed_dir
-#
-# only allow downloads for .dtorrents in this dir
-#
-
-# allowed_dir = ""
-
-#
-# allowed_list
-#
-# only allow downloads for hashes in this list (hex format, one per line)
-#
-
-# allowed_list = ""
-
-#
-# hupmonitor
-#
-# whether to reopen the log file upon receipt of HUP signal
+# HUP Monitor
+#
+# Whether to reopen the log file upon receipt of a HUP signal.
#
# hupmonitor = 0
#
-# http_timeout
-#
-# number of seconds to wait before assuming that an http connection has timed out
-#
-
-# http_timeout = 60
-
-#
# apt_parse_dir_interval
#
-# seconds between reloading of allowed_dir or allowed_file and allowed_ips and banned_ips lists for apt
+# The number of seconds between reloading of allowed_ips and banned_ips lists
+# for the APT request listener.
#
# apt_parse_dir_interval = 60
#
-# show_infopage
-#
-# whether to display an info page when the tracker's root dir is loaded
+# Show InfoPage
+#
+# Whether to display an information and statistics page when the APT
+# requester's root dir is loaded. If enabled, the page can be viewed at:
+#
+# http://localhost:9988/
+#
+# where 9988 is the port specified for listening for APT requests.
#
# show_infopage = 1
#
-# infopage_redirect
-#
-# a URL to redirect the info page to
+# InfoPage Redirect
+#
+# A URL to redirect the info page to. The Show InfoPage option must be set to
+# True (1) for this to work.
#
# infopage_redirect = ""
#
-# show_names
-#
-# whether to display names from allowed dir
-#
-
-show_names = 1
-
-#
# favicon
#
-# file containing x-icon data to return when browser requests favicon.ico
+# The file containing x-icon data to return when a browser requests
+# favicon.ico to the APT request listener.
#
# favicon = ""
#
-# allowed_ips
-#
-# only allow connections from IPs specified in the given file; file contains subnet data in the format: aa.bb.cc.dd/len
-#
+# Allowed IPs
+#
+# A file containing IPs to only allow connections from. The file must contain
+# a single subnet data on each line in the format:
+#
+# aa.bb.cc.dd/len
+#
+# Leaving this option empty allows all IPs to connect to the APT listener
+# (except for those listed in the Banned IPs ranges).
+#
+
# allowed_ips = ""
#
-# banned_ips
-#
-# don't allow connections from IPs specified in the given file; file contains IP range data in the format: xxx:xxx:ip1-ip2
+# Banned IPs
+#
+# A file containing IPs to NOT allow connections from. The file must contain
+# IP range data on each line in the format:
+#
+# xxx:xxx:ip1-ip2
#
# banned_ips = ""
#
-# logfile
-#
-# file to write the tracker logs, use - for stdout (default)
-#
-
-# logfile = ""
-
-#
-# allow_get
-#
-# use with allowed_dir; adds a /file?hash={hash} url that allows users to download the torrent file
+# Log File
+#
+# File to write the APT request listener logs to.
+#
+
+# logfile = "/var/log/debtorrent/apt_access.log"
+
+#
+# Allow Get
+#
+# Add a /file?hash={hash} url that allows users to download the torrent file
+# from the APT request linstener's info page.
#
# allow_get = 0
More information about the Debtorrent-commits
mailing list