File: dwww-find.8

package info (click to toggle)
dwww 1.10.3
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 676 kB
  • ctags: 261
  • sloc: perl: 2,774; ansic: 1,507; makefile: 153; sh: 130
file content (75 lines) | stat: -rw-r--r-- 1,846 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
.\" $Id: dwww-find.8,v 1.9 2006-06-04 14:38:18 robert Exp $
.\"
.TH DWWW-FIND 8 "June 4th, 2006" "dwww 1.10.0" "Debian"
.SH NAME
dwww\-find \- find documentation related to a search argument
.SH SYNOPSIS
.B "dwww-find" 
.RB [ \-\-program | \-\-menu | \-\-documentation | \-\-docfile ] 
.RB [ \-\-skip=\fInumber\fP ]
.IR "argument " [ ... ]
.SH DESCRIPTION
.B dwww-find
is part of the dwww package,
which provides access to on-line documentation on a Debian system via WWW.
.PP
.B dwww\-find
searches for a documentation related to a given program,
for entries from Debian Documentation Meny, or at least
for documents registered with doc-base.
It returns a HTML-formatted document with
search results.
.SH OPTIONS
.TP
.B \-\-program
Search for documentation  (man pages, info files, etc.) related to
program specified by
.IR argument .
.TP
.B \-\-menu
Search for entries in Debian Documentation Menu pages generated by 
.BR dwww\-build\-menu (8).
.TP
.B \-\-documentation
Search in documentation files registered with doc\-base.
It uses
.BR search++ (1)
for searching.
.TP
.B \-\-docfile
Search for documentation for package, which contains the file
specified by the
.IR argument .
The file must be located in or below a directory that has been allowed
by the system administrator; see
.BR dwww (8)
for more info.
.TP
.BI \-\-skip= number
Works only with
.BR \-\-documentation .
Skip 
.I number
of search results.
.PP
When no options are specified, 
.B \-\-program 
is assumed.
.SH FILES
.TP 
.I /etc/dwww/dwww.conf
Configuration file for dwww.
.SH "SEE ALSO"
.BR dwww (8),
.BR dwww\-quickfind (8),
.BR dwww\-build\-menu (8),
.BR dwww\-index++ (8),
.BR search++ (1),
.RI "Debian doc\-base Manual in "  /usr/share/doc/doc\-base/doc\-base.html/index.html .
.SH AUTHORS
Lars Wirzenius.
Robert Luberda.
.br
See
.BR dwww (8)
for copyrights and stuff.