summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJan-Michael Brummer <jan.brummer@tabos.org>2023-03-21 02:37:38 -0400
committerJan-Michael Brummer <jan.brummer@tabos.org>2023-03-27 16:31:58 +0200
commit580fc41f58d1128f5c53ec276c28bad96ba03491 (patch)
tree7042420c871a520145f3499b8428957c8a181c37
parentb365acbff1b8f01ae56e760470264cb66b39375a (diff)
downloadlibproxy-git-580fc41f58d1128f5c53ec276c28bad96ba03491.tar.gz
Update documentation (#102)
Co-authored-by: Jan-Michael Brummer <jan-michael.brummer1@volkswagen.de>
-rw-r--r--docs/build-steps.md4
-rw-r--r--docs/configuration-logic.md27
-rw-r--r--docs/proxy-authentication.md4
-rw-r--r--docs/px.toml.in2
4 files changed, 18 insertions, 19 deletions
diff --git a/docs/build-steps.md b/docs/build-steps.md
index fa3f187..f0ac5df 100644
--- a/docs/build-steps.md
+++ b/docs/build-steps.md
@@ -1,7 +1,7 @@
-Title: How to compile libproxy
+Title: Build steps - How to compile libproxy
Slug: building
-# How to compile libproxy
+# Build steps - How to compile libproxy
## Fedora
diff --git a/docs/configuration-logic.md b/docs/configuration-logic.md
index 342ef38..2229646 100644
--- a/docs/configuration-logic.md
+++ b/docs/configuration-logic.md
@@ -2,7 +2,6 @@ Title: Configuration Logic
Slug: Design
# Configuration Logic
-Source: https://code.google.com/archive/p/libproxy/wikis/ConfigurationLogic.wiki
## Introduction
As the proxy configuration predates libproxy, we need to consider previous
@@ -38,11 +37,11 @@ specific PAC file or to automatically discover one (WPAD) but those does not
contain any special logic. Next is the logic represent as pseudo code:
```
- IF not using same proxy for all protocols THEN
- IF SOCKS is set THEN use it
- ELSE IF protocol specific proxy is set THEN use it
- ELSE IF using same proxy for all protocols THEN
- IF SOCKS is set THEN use it
+ IF not using same proxy for all protocols THEN
+ IF SOCKS is set THEN use it
+ ELSE IF protocol specific proxy is set THEN use it
+ ELSE IF using same proxy for all protocols THEN
+ IF SOCKS is set THEN use it
IF no proxy has been set THEN use direct connection
```
@@ -64,14 +63,14 @@ testing the order seems to be from most specific to most generic (starting with
manual configuration). Next is the logic represented as pseudo code:
```
- DEFINE proxy_list as list
- IF protocol specific proxy is set THEN add it to proxy_list
- IF SOCKS proxy is set THEN append it to proxy_list
- IF PAC auto-configuration is set THEN append it to proxy_list
- FOREACH proxy in proxy_list
- connect to proxy
- IF connection failed THEN continue
- ELSE stop
+ DEFINE proxy_list as list
+ IF protocol specific proxy is set THEN add it to proxy_list
+ IF SOCKS proxy is set THEN append it to proxy_list
+ IF PAC auto-configuration is set THEN append it to proxy_list
+ FOREACH proxy in proxy_list
+ connect to proxy
+ IF connection failed THEN continue
+ ELSE stop
```
## Windows
diff --git a/docs/proxy-authentication.md b/docs/proxy-authentication.md
index 8b9669d..de7a905 100644
--- a/docs/proxy-authentication.md
+++ b/docs/proxy-authentication.md
@@ -1,7 +1,7 @@
-Title: What about Proxy Authentication?
+Title: Proxy Authentication
Slug: ProxyAuthentication
-# What about Proxy Authentication?
+# Proxy Authentication
Because proxy authentication is protocol specific, it is outside the scope of this library. libproxy tells you WHICH proxy servers to try to use,
not HOW to use them.
diff --git a/docs/px.toml.in b/docs/px.toml.in
index c08c679..1e7f88a 100644
--- a/docs/px.toml.in
+++ b/docs/px.toml.in
@@ -65,8 +65,8 @@ content_files = [
"applications.md",
"build-steps.md",
"configuration-logic.md",
- "perl.md",
"proxy-authentication.md",
+ "perl.md",
"python.md",
"ruby.md",
"vala.md",