Find Help File Containing a Specific Help Topic.

DESCRIPTION:

Find a help file containing a specific help topic.

USAGE:

find.doc(what, defaultname=paste(getenv("SHOME"), "\\cmd\\splus.chm", sep = ""), 
        find.all=F, suppress.display=T, hidden.keyword.search=F))

REQUIRED ARGUMENTS:

what
character string giving the topic for which help is to be found.

OPTIONAL ARGUMENTS:

defaultname
Used only in the Windows version of S-PLUS. Specifies a default help file to search for help.
find.all
Finds all instances of help, not just the first instance returned. Default= F.
suppress.display
Specifies whether to display or to suppress the display of the instance found. Cannot be F if find.all=T. Default= T.
hidden.keyword.search
Windows only. Specifies whether the search includes only displayed titles or includes hidden keywords (that is, those defined as alinks). The default specifies HH_KEYWORD_LOOKUP; otherwise, specifies HH_DISPLAY_SEARCH. Default= F.

VALUE:

a character string containing one or more paths to help files.

SIDE EFFECTS:

None.

DETAILS:

Searches all the help sets known to S-PLUS for the specified topic. If no help is found in these help sets, S-PLUS generates self-doc for the desired object, if it exists.

SEE ALSO:

.

EXAMPLES:

find.doc("help")
find.doc("for",suppress.display=F,find.all=F)