Skip to content

Commit

Permalink
Updated Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Stanislas Polu committed Dec 2, 2014
1 parent c21cade commit 2f1b2d9
Showing 1 changed file with 42 additions and 1 deletion.
43 changes: 42 additions & 1 deletion docs/api/session.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,48 @@ Adds the specified url to the list of visited links for this session

Clears the visited links storage for this session

#### Accessor: `off_the_record`
#### Method: `proxy_set`

- `rules` proxy rules string

Sets the specified proxy rules (as string) for the current session

```
proxy-uri = [<proxy-scheme>"://"]<proxy-host>[":"<proxy-port>]
proxy-uri-list = <proxy-uri>[","<proxy-uri-list>]
url-scheme = "http" | "https" | "ftp" | "socks"
scheme-proxies = [<url-scheme>"="]<proxy-uri-list>
proxy-rules = scheme-proxies[";"<scheme-proxies>]
```

For example:
```
"http=foopy:80;ftp=foopy2" -- use HTTP proxy "foopy:80" for http://
URLs, and HTTP proxy "foopy2:80" for
ftp:// URLs.
"foopy:80" -- use HTTP proxy "foopy:80" for all URLs.
"foopy:80,bar,direct://" -- use HTTP proxy "foopy:80" for all URLs,
failing over to "bar" if "foopy:80" is
unavailable, and after that using no
proxy.
"socks4://foopy" -- use SOCKS v4 proxy "foopy:1080" for all
URLs.
"http=foop,socks5://bar.com -- use HTTP proxy "foopy" for http URLs,
and fail over to the SOCKS5 proxy
"bar.com" if "foop" is unavailable.
"http=foopy,direct:// -- use HTTP proxy "foopy" for http URLs,
and use no proxy if "foopy" is
unavailable.
"http=foopy;socks=foopy2 -- use HTTP proxy "foopy" for http URLs,
and use socks4://foopy2 for all other
URLs.
```

#### Method: `proxy_clear`

Clears the proxy rules string for this session

#### Accessor: `is_off_the_record`

Returns whether the session is off the record or not

Expand Down

0 comments on commit 2f1b2d9

Please sign in to comment.