| 1 | .\"------------------------------------------------------------
|
|---|
| 2 | .\" Id - set Rv,revision, and Dt, Date using rcs-Id tag.
|
|---|
| 3 | .de Id
|
|---|
| 4 | .ds Rv \\$3
|
|---|
| 5 | .ds Dt \\$4
|
|---|
| 6 | ..
|
|---|
| 7 | .Id $Id: mg_hilite_words.1 3745 2003-02-20 21:20:24Z mdewsnip $
|
|---|
| 8 | .\"------------------------------------------------------------
|
|---|
| 9 | .TH mg_hilite_words 1 \*(Dt CITRI
|
|---|
| 10 | .SH NAME
|
|---|
| 11 | mg_hilite_words \- display text and highlight particular words which it contains
|
|---|
| 12 | .SH SYNOPSIS
|
|---|
| 13 | .B mg_hilite_words
|
|---|
| 14 | .if n .ti +9n
|
|---|
| 15 | [
|
|---|
| 16 | .B --stem_method [0-3]
|
|---|
| 17 | ]
|
|---|
| 18 | .if n .ti +9n
|
|---|
| 19 | [
|
|---|
| 20 | .B --stemmer [english|lovin|french|simplefrench]
|
|---|
| 21 | ]
|
|---|
| 22 | .if n .ti +9n
|
|---|
| 23 | [
|
|---|
| 24 | .B --style [bold|underline|italic|emphasis|strong]
|
|---|
| 25 | ]
|
|---|
| 26 | .if n .ti +9n
|
|---|
| 27 | [
|
|---|
| 28 | .B --pager [less|more|html|???]
|
|---|
| 29 | ]
|
|---|
| 30 | .if n .ti +9n
|
|---|
| 31 | .I list-of-words-to-highlight
|
|---|
| 32 |
|
|---|
| 33 | .SH DESCRIPTION
|
|---|
| 34 | .B mg_hilite_words
|
|---|
| 35 | reads text from stdin and outputs it into a pager such as
|
|---|
| 36 | less. It's command arguments include a list of stemmed words
|
|---|
| 37 | which if extracted from the text will be highlighted on the output
|
|---|
| 38 | using a highlighting style.
|
|---|
| 39 |
|
|---|
| 40 | It has been extended to output the highlighted text using html
|
|---|
| 41 | straight to stdout.
|
|---|
| 42 |
|
|---|
| 43 | .SH OPTIONS
|
|---|
| 44 | Options may appear in any order, but the
|
|---|
| 45 | .IR list-of-words-to-highlight ,
|
|---|
| 46 | must be last.
|
|---|
| 47 | .TP
|
|---|
| 48 | .B --stem_method [0-3]
|
|---|
| 49 | This option allows one to set the stemming method for the extraction of
|
|---|
| 50 | the words from the incoming text.
|
|---|
| 51 | This should match the way the inverted file index was created.
|
|---|
| 52 | The default is 3, which is fold and stem.
|
|---|
| 53 | .TP
|
|---|
| 54 | .B --stemmer [english|lovin|french|simplefrench]
|
|---|
| 55 | This option allows you to select the stemmer to use. The
|
|---|
| 56 | default is the English stemmer.
|
|---|
| 57 | .TP
|
|---|
| 58 | .B --style [bold|underline|italic|emphasis|strong]
|
|---|
| 59 | This option sets the highlighting style.
|
|---|
| 60 | .IR Bold
|
|---|
| 61 | and
|
|---|
| 62 | .IR underline
|
|---|
| 63 | are utilised by the pager or for html output.
|
|---|
| 64 | .IR Italic,
|
|---|
| 65 | .IR emphasis,
|
|---|
| 66 | and
|
|---|
| 67 | .IR strong
|
|---|
| 68 | can only be used for html output.
|
|---|
| 69 | .TP
|
|---|
| 70 | .B --pager [less|more|html|???]
|
|---|
| 71 | One can use the standard
|
|---|
| 72 | .IR less
|
|---|
| 73 | or
|
|---|
| 74 | .IR more
|
|---|
| 75 | pages for displaying the highlighted text.
|
|---|
| 76 | Or one can generate highlighted html using the paging setting of
|
|---|
| 77 | .IR html.
|
|---|
| 78 | One can also specify a custom pager of their own choosing (i.e. ???).
|
|---|
| 79 | .TP
|
|---|
| 80 | .B list-of-words-to-highlight
|
|---|
| 81 | Each word is taken as a command line argument.
|
|---|
| 82 | Each word should already be stemmed and folded according to
|
|---|
| 83 | the stem option.
|
|---|
| 84 | .SH USAGE
|
|---|
| 85 | This program was written primarily to be called by
|
|---|
| 86 | .IR mgquery(1)
|
|---|
| 87 | .
|
|---|
| 88 | When the user selects the mode of "hilite" then this program
|
|---|
| 89 | is called for displaying the query-result documents instead of
|
|---|
| 90 | just the pager.
|
|---|
| 91 | .SH "SEE ALSO"
|
|---|
| 92 | .na
|
|---|
| 93 | .BR mgquery (1).
|
|---|
| 94 |
|
|---|
| 95 |
|
|---|
