Skip to content

Commit

Permalink
Add documentation files that I forgot to add earlier.
Browse files Browse the repository at this point in the history
  • Loading branch information
manugarg committed Apr 22, 2011
1 parent 8ff47b9 commit a9af1ae
Show file tree
Hide file tree
Showing 5 changed files with 208 additions and 29 deletions.
58 changes: 58 additions & 0 deletions docs/html/pacparser_parse_pac_file.3.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<!-- manual page source format generated by PolyglotMan v3.2, -->
<!-- available at http://polyglotman.sourceforge.net/ -->

<html>
<head>
<title>"pacparser_parse_pac_file"(3) manual page</title>
</head>
<body bgcolor='white'>
<a href='#toc'>Table of Contents</a><p>

<h2><a name='sect0' href='#toc0'>Name</a></h2>
pacparser_parse_pac_file - Parses the given PAC file.
<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
<b>#include
&lt;pacparser.h&gt; <p>
int pacparser_parse_pac_file(const char *pacfile);
<h2><a name='sect2' href='#toc2'></b>Parameters</a></h2>

<dl>

<dt><b>const
char *pacfile</b> </dt>
<dd>PAC file to parse. </dd>
</dl>

<h2><a name='sect3' href='#toc3'>Description</a></h2>
Reads the given PAC file and
evaluates it in the JavaScript context created by pacparser_init.
<h2><a name='sect4' href='#toc4'>Returns</a></h2>
0
on failure and 1 on success.
<h2><a name='sect5' href='#toc5'>See Also</a></h2>
<a href='pacparser_version.3.html'>pacparser_version(3)</a>
, <a href='pacparser_init.3.html'>pacparser_init(3)</a>
,
<a href='pacparser_parse_pac_string.3.html'>pacparser_parse_pac_string(3)</a>
, <a href='pacparser_parse_pac.3.html'>pacparser_parse_pac(3)</a>
, <a href='pacparser_find_proxy.3.html'>pacparser_find_proxy(3)</a>
,
<a href='pacparser_just_find_proxy.3.html'>pacparser_just_find_proxy(3)</a>
, <a href='pacparser_cleanup.3.html'>pacparser_cleanup(3)</a>
, <a href='pacparser_setmyip.3.html'>pacparser_setmyip(3)</a>
,
<a href='pacparser_enable_microsoft_extensions.3.html'>pacparser_enable_microsoft_extensions(3)</a>
<p>

<hr><p>
<a name='toc'><b>Table of Contents</b></a><p>
<ul>
<li><a name='toc0' href='#sect0'>Name</a></li>
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
<li><a name='toc2' href='#sect2'>Parameters</a></li>
<li><a name='toc3' href='#sect3'>Description</a></li>
<li><a name='toc4' href='#sect4'>Returns</a></li>
<li><a name='toc5' href='#sect5'>See Also</a></li>
</ul>
</body>
</html>
58 changes: 58 additions & 0 deletions docs/html/pacparser_parse_pac_string.3.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<!-- manual page source format generated by PolyglotMan v3.2, -->
<!-- available at http://polyglotman.sourceforge.net/ -->

<html>
<head>
<title>"pacparser_parse_pac_string"(3) manual page</title>
</head>
<body bgcolor='white'>
<a href='#toc'>Table of Contents</a><p>

<h2><a name='sect0' href='#toc0'>Name</a></h2>
pacparser_parse_pac_string - Parses the given PAC script string.
<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
<b>#include
&lt;pacparser.h&gt; <p>
int pacparser_parse_pac_string(const char *string);
<h2><a name='sect2' href='#toc2'></b>Parameters</a></h2>

<dl>

<dt><b>const
char *string</b> </dt>
<dd>PAC string to parse. </dd>
</dl>

<h2><a name='sect3' href='#toc3'>Description</a></h2>
Evaulates the given PAC script
string in the JavaScript context created by pacparser_init.
<h2><a name='sect4' href='#toc4'>Returns</a></h2>
0 on
failure and 1 on success.
<h2><a name='sect5' href='#toc5'>See Also</a></h2>
<a href='pacparser_version.3.html'>pacparser_version(3)</a>
, <a href='pacparser_init.3.html'>pacparser_init(3)</a>
,
<a href='pacparser_parse_pac_file.3.html'>pacparser_parse_pac_file(3)</a>
, <a href='pacparser_parse_pac.3.html'>pacparser_parse_pac(3)</a>
, <a href='pacparser_find_proxy.3.html'>pacparser_find_proxy(3)</a>
,
<a href='pacparser_just_find_proxy.3.html'>pacparser_just_find_proxy(3)</a>
, <a href='pacparser_cleanup.3.html'>pacparser_cleanup(3)</a>
, <a href='pacparser_setmyip.3.html'>pacparser_setmyip(3)</a>
,
<a href='pacparser_enable_microsoft_extensions.3.html'>pacparser_enable_microsoft_extensions(3)</a>
<p>

<hr><p>
<a name='toc'><b>Table of Contents</b></a><p>
<ul>
<li><a name='toc0' href='#sect0'>Name</a></li>
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
<li><a name='toc2' href='#sect2'>Parameters</a></li>
<li><a name='toc3' href='#sect3'>Description</a></li>
<li><a name='toc4' href='#sect4'>Returns</a></li>
<li><a name='toc5' href='#sect5'>See Also</a></li>
</ul>
</body>
</html>
61 changes: 32 additions & 29 deletions docs/html/pactester.1.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,66 +17,69 @@ <h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
[-c client_ip] [-e]</b>
<h2><a name='sect2' href='#toc2'>Description</a></h2>
pactester is a tool to test proxy auto-config
(pac) files. It uses pacparser library to parse pac files and return proxy
string for the specified URL.
(pac) files. It returns the proxy config string for the given URL and the
pac file. pactester uses pacparser C library for most of its functionality.

<h2><a name='sect3' href='#toc3'>Options</a></h2>

<dl>

<dt><b>-p pacfile</b> </dt>
<dd>PAC file to test. Specify
"-" to read from standard input. </dd>
<dd>PAC file to test. Specify "-" to read from the standard
input. </dd>

<dt><b>-u url</b> </dt>
<dd>URL to test PAC file for. </dd>
<dd>URL to test the PAC file for. </dd>

<dt><b>-h host</b> </dt>
<dd>Host
part of the URL. If not specified, it&rsquo;s determined from the URL. </dd>
<dd>Host part of the URL. If
not specified, it&rsquo;s determined from the URL. </dd>

<dt><b>-c client_ip</b>
</dt>
<dd>Client&rsquo;s IP address (as returned by the function myIpAddress() in PAC files).
If not specified, it defaults to the IP address of the machine on which
it is running. </dd>
<dt><b>-c client_ip</b> </dt>
<dd>Client&rsquo;s IP address
(as returned by the function myIpAddress() in PAC files). If not specified,
it defaults to the IP address of the machine on which this tool is running.
</dd>

<dt><b>-e</b> </dt>
<dd>Enable Microsoft PAC extensions (dnsResolveEx, myIpAddressEx,
isResolvableEx). </dd>
<dd>Enable Microsoft PAC extensions (dnsResolveEx, myIpAddressEx, isResolvableEx).
</dd>

<dt><b>-f urlslist</b> </dt>
<dd>A file containing list of URLs to be tested.
This is good for testing a PAC file against a set of URLs. </dd>
<dd>A file containing the list of URLs to be tested. This is good
for testing a PAC file against a set of URLs. </dd>
</dl>

<h2><a name='sect4' href='#toc4'>Examples</a></h2>
<p>
To find
out proxy string as returned by pac file wpad.dat for the URL <a href='http://www.google.com:'>http://www.google.com:</a>

To find out the proxy
config string for the pac file "wpad.dat" and the URL "<a href='http://www.google.com'>http://www.google.com</a>
":
<p>
$ pactester -p wpad.dat -u <a href='http://www.google.com'>http://www.google.com</a>

<p> For a client with IP address
10.0.12.123: <p>
$ pactester -p wpad.dat -c 10.0.12.123 -u <a href='http://www.google.com'>http://www.google.com</a>

<p> To find
out proxy string for a list of urls specified in /tmp/urls: <p>
$ pactester
-p wpad.dat -f /tmp/urls
<p> For a
pac file hosted at <a href='http://wpad/wpad.dat:'>http://wpad/wpad.dat:</a>
<p>
$ curl -s <a href='http://wpad/wpad.dat'>http://wpad/wpad.dat</a>
| pactester
-p - -u <a href='http://google.com'>http://google.com</a>

<h2><a name='sect5' href='#toc5'>Bugs</a></h2>
If you have come across a bug in pactester, please
submit a bug report at <a href='http://code.google.com/p/pacparser/issues/list.'>http://code.google.com/p/pacparser/issues/list.</a>

<h2><a name='sect6' href='#toc6'>Author</a></h2>
Written
by Manu Garg (http://www.manugarg.com).
<h2><a name='sect7' href='#toc7'>See Also</a></h2>
More information about this
version of pactester and pacparser library can be found at pacparser homepage:
<a href='http://code.google.com/p/pacparser.'>http://code.google.com/p/pacparser.</a>

<h2><a name='sect7' href='#toc7'>Resources</a></h2>
Homepage: <a href='http://code.google.com/p/pacparser.'>http://code.google.com/p/pacparser.</a>


<p> <p>

<hr><p>
Expand All @@ -89,7 +92,7 @@ <h2><a name='sect7' href='#toc7'>See Also</a></h2>
<li><a name='toc4' href='#sect4'>Examples</a></li>
<li><a name='toc5' href='#sect5'>Bugs</a></li>
<li><a name='toc6' href='#sect6'>Author</a></li>
<li><a name='toc7' href='#sect7'>See Also</a></li>
<li><a name='toc7' href='#sect7'>Resources</a></li>
</ul>
</body>
</html>
30 changes: 30 additions & 0 deletions docs/pacparser_parse_pac_file.3
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
.TH "pacparser_parse_pac_file" 3 "20 March 2011" "c2man pacparser.h"
.SH "NAME"
pacparser_parse_pac_file \- Parses the given PAC file.
.SH "SYNOPSIS"
.ft B
#include <pacparser.h>
.sp
int pacparser_parse_pac_file(const char *pacfile);
.ft R
.SH "PARAMETERS"
.TP
.B "const char *pacfile"
PAC file to parse.
.SH "DESCRIPTION"
Reads the given PAC file and evaluates it in the JavaScript context created
by pacparser_init.
.SH "RETURNS"
0 on failure and 1 on success.
.SH "SEE ALSO"
pacparser_version(3),
pacparser_init(3),
pacparser_parse_pac_string(3),
pacparser_parse_pac(3),
pacparser_find_proxy(3),
pacparser_just_find_proxy(3),
pacparser_cleanup(3),
pacparser_setmyip(3),
pacparser_enable_microsoft_extensions(3)
30 changes: 30 additions & 0 deletions docs/pacparser_parse_pac_string.3
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
.TH "pacparser_parse_pac_string" 3 "20 March 2011" "c2man pacparser.h"
.SH "NAME"
pacparser_parse_pac_string \- Parses the given PAC script string.
.SH "SYNOPSIS"
.ft B
#include <pacparser.h>
.sp
int pacparser_parse_pac_string(const char *string);
.ft R
.SH "PARAMETERS"
.TP
.B "const char *string"
PAC string to parse.
.SH "DESCRIPTION"
Evaulates the given PAC script string in the JavaScript context created
by pacparser_init.
.SH "RETURNS"
0 on failure and 1 on success.
.SH "SEE ALSO"
pacparser_version(3),
pacparser_init(3),
pacparser_parse_pac_file(3),
pacparser_parse_pac(3),
pacparser_find_proxy(3),
pacparser_just_find_proxy(3),
pacparser_cleanup(3),
pacparser_setmyip(3),
pacparser_enable_microsoft_extensions(3)

0 comments on commit a9af1ae

Please sign in to comment.