aboutsummaryrefslogtreecommitdiff
path: root/spec/bandwidth-file-spec-intro.md
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2023-10-12 12:27:58 -0400
committerNick Mathewson <nickm@torproject.org>2023-10-12 12:27:58 -0400
commitf7e5a95ee96d8ef52c1732d066c1249a6f84391e (patch)
tree2e1ddd85f471143518d0df7c7645d066d43bc149 /spec/bandwidth-file-spec-intro.md
parente4e0d93d56ee8c1aec4c2efaa7046b651f0fe55c (diff)
downloadtorspec-f7e5a95ee96d8ef52c1732d066c1249a6f84391e.tar.gz
torspec-f7e5a95ee96d8ef52c1732d066c1249a6f84391e.zip
Convert text specifications to mdbook.
Diffstat (limited to 'spec/bandwidth-file-spec-intro.md')
-rw-r--r--spec/bandwidth-file-spec-intro.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/spec/bandwidth-file-spec-intro.md b/spec/bandwidth-file-spec-intro.md
new file mode 100644
index 0000000..1fd5354
--- /dev/null
+++ b/spec/bandwidth-file-spec-intro.md
@@ -0,0 +1,33 @@
+```text
+ Tor Bandwidth File Format
+ juga
+ teor
+
+Table of Contents
+
+ 1. Scope and preliminaries
+ 1.2. Acknowledgements
+ 1.3. Outline
+ 1.4. Format Versions
+ 2. Format details
+ 2.1. Definitions
+ 2.2. Header List format
+ 2.3. Relay Line format
+ 2.4. Implementation details
+ 2.4.1. Writing bandwidth files atomically
+ 2.4.2. Additional KeyValue pair definitions
+ 2.4.2.1. Simple Bandwidth Scanner
+ 2.4.2.2. Torflow
+ A. Sample data
+ A.1. Generated by Torflow
+ A.2. Generated by sbws version 0.1.0
+ A.3. Generated by sbws version 1.0.3
+ A.4. Headers generated by sbws version 1.0.4
+ A.5 Generated by sbws version 1.1.0
+ B. Scaling bandwidths
+ B.1. Scaling requirements
+ B.2. A linear scaling method
+ B.3. Quota changes
+ B.4. Torflow aggregation
+```
+