aboutsummaryrefslogtreecommitdiff
path: root/spec/bandwidth-file-spec/index.md
diff options
context:
space:
mode:
Diffstat (limited to 'spec/bandwidth-file-spec/index.md')
-rw-r--r--spec/bandwidth-file-spec/index.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/spec/bandwidth-file-spec/index.md b/spec/bandwidth-file-spec/index.md
new file mode 100644
index 0000000..86563fa
--- /dev/null
+++ b/spec/bandwidth-file-spec/index.md
@@ -0,0 +1,18 @@
+# Tor Bandwidth File Format
+
+```text
+ juga
+ teor
+```
+
+This document describes the format of Tor's Bandwidth File, version
+1.0.0 and later.
+
+It is a new specification for the existing bandwidth file format,
+which we call version 1.0.0. It also specifies new format versions
+1.1.0 and later, which are backwards compatible with 1.0.0 parsers.
+
+Since Tor version 0.2.4.12-alpha, the directory authorities use
+the Bandwidth File file called "V3BandwidthsFile" generated by
+Torflow \[1\]. The details of this format are described in Torflow's
+README.spec.txt. We also summarise the format in this specification.