W3C home > Mailing lists > Public > www-validator-cvs@w3.org > August 2010

link-checker commit: Various doc improvements.

From: Mercurial notifier <nobody@w3.org>
Date: Thu, 05 Aug 2010 14:46:54 +0000
To: link-checker updates <www-validator-cvs@w3.org>
Message-Id: <E1Oh1ig-0005VZ-5D@blinky.w3.org>
changeset:   25:972f7f3b91b7
user:        ville
date:        Tue Mar 30 19:04:22 2004 +0000
files:       bin/checklink.pod
description:
Various doc improvements.


diff -r 46b9155a458b -r 972f7f3b91b7 bin/checklink.pod
--- a/bin/checklink.pod	Sat Mar 27 19:14:34 2004 +0000
+++ b/bin/checklink.pod	Tue Mar 30 19:04:22 2004 +0000
@@ -1,4 +1,4 @@
-$Id: checklink.pod,v 1.4 2004-03-27 19:09:41 ville Exp $
+$Id: checklink.pod,v 1.5 2004-03-30 19:04:22 ville Exp $
 
 =head1 NAME
 
@@ -6,11 +6,12 @@
 
 =head1 SYNOPSIS
 
-B<checklink>  [ I<options> ] I<URI> ...
+B<checklink>  [ I<options> ] I<uri> ...
 
 =head1 DESCRIPTION
 
-This manual page documents briefly the B<checklink> command.
+This manual page documents briefly the B<checklink> command, a.k.a. the
+W3C® Link Checker.
 
 B<checklink> is a program that reads an HTML or XHTML document,
 extracts a list of anchors and lists and checks that no anchor is
@@ -18,7 +19,7 @@
 the fragments. It warns about HTTP redirects, including directory
 redirects, and can check recursively a part of a web site.
 
-The program can be used either as a command-line version or as a CGI script.
+The program can be used either as a command line tool or as a CGI script.
 
 =head1 OPTIONS
 
@@ -37,7 +38,7 @@
 
 =item B<-s, --summary>
 
-Result summary only.
+Show result summary only.
 
 =item B<-b, --broken>
 
@@ -52,12 +53,12 @@
 
 Check the documents linked from the first one.
 
-=item B<-D, --depth n>
+=item B<-D, --depth> I<n>
 
-Check the documents linked from the first one to depth n
-(implies --recursive).
+Check the documents linked from the first one to depth I<n>
+(implies B<--recursive>).
 
-=item B<-l, --location uri>
+=item B<-l, --location> I<uri>
 
 Scope of the documents checked in recursive mode. By default, for
 L<http://www.w3.org/TR/html4/Overview.html> for example, it would be
@@ -67,7 +68,7 @@
 
 Do not send an Accept-Language header.
 
-=item B<-L, --languages>
+=item B<-L, --languages> I<langs>
 
 Languages accepted (default: '*').
 
@@ -83,40 +84,40 @@
 
 Show progress while parsing.
 
-=item B<-u, --user username>
+=item B<-u, --user> I<username>
 
 Specify a username for authentication.
 
-=item B<-p, --password password>
+=item B<-p, --password> I<password>
 
-Specify a password.
+Specify a password for authentication.
 
 =item B<--hide-same-realm>
 
 Hide 401's that are in the same realm as the document checked.
 
-=item B<-t, --timeout value>
+=item B<-t, --timeout> I<secs>
 
-Timeout for the HTTP requests.
+Timeout for requests, in seconds.
 
-=item B<-d, --domain domain>
+=item B<-d, --domain> I<domain>
 
-Regular expression describing the domain to which the authentication
-information will be sent.  The default value can be specified in the
-checklink configuration file.
+Perl regular expression describing the domain to which the authentication
+information (if present) will be sent.  The default value can be specified
+in the configuration file.
 
-=item B<--masquerade "local remote">
+=item B<--masquerade> I<"local remote">
 
 Masquerade local dir as a remote URI.  For example, the following results in
 /my/local/dir/ being "mapped" to http://some/remote/uri/
 
   --masquerade "/my/local/dir http://some/remote/uri/"
 
-As of revision 3.6.2.19 of checklink, --masquerade takes a single
+As of revision 3.6.2.19 of checklink, B<--masquerade> takes a single
 argument consisting of two URIs, separated by whitespace.  One usual way of
 providing a value with embedded whitespace is to enclose it in quotes.
 
-=item B<-y, --proxy proxy>
+=item B<-y, --proxy> I<proxy>
 
 Specify an HTTP proxy server.
 
@@ -180,7 +181,7 @@
 The documentation for this program is available on the web at
 L<http://www.w3.org/2000/07/checklink>.
 
-LWP(3), L<Net::FTP(3)>, L<Net::NNTP(3)>, L<Net::IP>.
+L<LWP>, L<Net::FTP>, L<Net::NNTP>, L<Net::IP>, L<perlre>.
 
 =head1 AUTHOR
 
Received on Thursday, 5 August 2010 14:47:07 UTC

This archive was generated by hypermail 2.3.1 : Wednesday, 7 January 2015 15:17:43 UTC