[ Previous | Next | Contents | Glossary | Home | Search ]
AIX Version 4.3 Commands Reference, Volume 2

docsearch Command

Purpose

Launches the AIX Documentation Search Service global search form.

Syntax

Syntax

docsearch [ -lang locale ]

Description

The docsearch command launches the AIX Documentation Search Service global search form into a web browser window. This global search form shows all indexes (document volumes/collections) that are registered with the search service on the documentation server. Select the volumes you want to search and then type in the words you want to search for. The search service then returns a list of the documents that contain the query words. Each document is shown as a hyperlink that opens the document for reading. The client or server portion of the AIX Documentation Search Service package must be installed to enable this command.

The docsearch command reads the environment variables DOCUMENT_SERVER_MACHINE_NAME and DOCUMENT_SERVER_PORT to determine the hostname of the machine where the documents are located and the port of the webserver on that machine.

Flags

-lang locale Uses the language specified in locale to create the search form. Use the standard AIX locale names to specify locale. This specifies the language for the search form buttons and lables. The form will only offer for search those document (indexes) that are written in that language and the search will be conducted in the same language.

Examples

To open the global search form German (locale=de_DE) and only show all German indexes installed on the system, enter:

docsearch -lang de_DE

Files

/usr/bin/docsearch The docsearch command
/usr/lib/nls/msg/$LANG/docsearch.cat The docsearch message catalog
/usr/bin/defaultbrowser The defaultbrowser command

Related Information

The defaultbrowser command.

The Documentation Search Service chapters in the System Management guide and the General Programming Concepts guide.


[ Previous | Next | Contents | Glossary | Home | Search ]