From a9af1aeef7fc896c0648e533c6bd5d6c58c2e9ed Mon Sep 17 00:00:00 2001 From: manugarg Date: Fri, 22 Apr 2011 21:34:39 +0530 Subject: [PATCH] Add documentation files that I forgot to add earlier. --- docs/html/pacparser_parse_pac_file.3.html | 58 ++++++++++++++++++++ docs/html/pacparser_parse_pac_string.3.html | 58 ++++++++++++++++++++ docs/html/pactester.1.html | 61 +++++++++++---------- docs/pacparser_parse_pac_file.3 | 30 ++++++++++ docs/pacparser_parse_pac_string.3 | 30 ++++++++++ 5 files changed, 208 insertions(+), 29 deletions(-) create mode 100644 docs/html/pacparser_parse_pac_file.3.html create mode 100644 docs/html/pacparser_parse_pac_string.3.html create mode 100644 docs/pacparser_parse_pac_file.3 create mode 100644 docs/pacparser_parse_pac_string.3 diff --git a/docs/html/pacparser_parse_pac_file.3.html b/docs/html/pacparser_parse_pac_file.3.html new file mode 100644 index 00000000..83a4b727 --- /dev/null +++ b/docs/html/pacparser_parse_pac_file.3.html @@ -0,0 +1,58 @@ + + + + + +"pacparser_parse_pac_file"(3) manual page + + +Table of Contents

+ +

Name

+pacparser_parse_pac_file - Parses the given PAC file. +

Synopsis

+#include +<pacparser.h>

+int pacparser_parse_pac_file(const char *pacfile); +

Parameters

+ +
+ +
const +char *pacfile
+
PAC file to parse.
+
+ +

Description

+Reads the given PAC file and +evaluates it in the JavaScript context created by pacparser_init. +

Returns

+0 +on failure and 1 on success. +

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) +

+ +

+Table of Contents

+

+ + diff --git a/docs/html/pacparser_parse_pac_string.3.html b/docs/html/pacparser_parse_pac_string.3.html new file mode 100644 index 00000000..524545ad --- /dev/null +++ b/docs/html/pacparser_parse_pac_string.3.html @@ -0,0 +1,58 @@ + + + + + +"pacparser_parse_pac_string"(3) manual page + + +Table of Contents

+ +

Name

+pacparser_parse_pac_string - Parses the given PAC script string. +

Synopsis

+#include +<pacparser.h>

+int pacparser_parse_pac_string(const char *string); +

Parameters

+ +
+ +
const +char *string
+
PAC string to parse.
+
+ +

Description

+Evaulates the given PAC script +string in the JavaScript context created by pacparser_init. +

Returns

+0 on +failure and 1 on success. +

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) +

+ +

+Table of Contents

+

+ + diff --git a/docs/html/pactester.1.html b/docs/html/pactester.1.html index 6d1fcef8..643b465e 100644 --- a/docs/html/pactester.1.html +++ b/docs/html/pactester.1.html @@ -17,43 +17,44 @@

Synopsis

[-c client_ip] [-e]

Description

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. +

Options

-p pacfile
-
PAC file to test. Specify -"-" to read from standard input.
+
PAC file to test. Specify "-" to read from the standard +input.
-u url
-
URL to test PAC file for.
+
URL to test the PAC file for.
-h host
-
Host -part of the URL. If not specified, it’s determined from the URL.
+
Host part of the URL. If +not specified, it’s determined from the URL.
-
-c client_ip -
-
Client’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.
+
-c client_ip
+
Client’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. +
-e
-
Enable Microsoft PAC extensions (dnsResolveEx, myIpAddressEx, -isResolvableEx).
+
Enable Microsoft PAC extensions (dnsResolveEx, myIpAddressEx, isResolvableEx). +
-f urlslist
-
A file containing list of URLs to be tested. -This is good for testing a PAC file against a set of URLs.
+
A file containing the list of URLs to be tested. This is good +for testing a PAC file against a set of URLs.

Examples

-To find -out proxy string as returned by pac file wpad.dat for the URL http://www.google.com: - +To find out the proxy +config string for the pac file "wpad.dat" and the URL "http://www.google.com +":

$ pactester -p wpad.dat -u http://www.google.com @@ -61,10 +62,13 @@

Examples

10.0.12.123:

$ pactester -p wpad.dat -c 10.0.12.123 -u http://www.google.com -

To find -out proxy string for a list of urls specified in /tmp/urls:

-$ pactester --p wpad.dat -f /tmp/urls +

For a +pac file hosted at http://wpad/wpad.dat: +

+$ curl -s http://wpad/wpad.dat + | pactester +-p - -u http://google.com +

Bugs

If you have come across a bug in pactester, please submit a bug report at http://code.google.com/p/pacparser/issues/list. @@ -72,11 +76,10 @@

Bugs

Author

Written by Manu Garg (http://www.manugarg.com). -

See Also

-More information about this -version of pactester and pacparser library can be found at pacparser homepage: -http://code.google.com/p/pacparser. - +

Resources

+Homepage: http://code.google.com/p/pacparser. + +

@@ -89,7 +92,7 @@

See Also

  • Examples
  • Bugs
  • Author
    • -
  • See Also
    • +
  • Resources
    • diff --git a/docs/pacparser_parse_pac_file.3 b/docs/pacparser_parse_pac_file.3 new file mode 100644 index 00000000..32107a08 --- /dev/null +++ b/docs/pacparser_parse_pac_file.3 @@ -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 +.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) diff --git a/docs/pacparser_parse_pac_string.3 b/docs/pacparser_parse_pac_string.3 new file mode 100644 index 00000000..df7acc69 --- /dev/null +++ b/docs/pacparser_parse_pac_string.3 @@ -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 +.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)