# man(3)

[Home] [Commands] [Variables] [Macro-Dev] [Glossary]

## NAME

man - UNIX manual page viewer.
man-clean - Clean UNIX manual page.
%man-com - Man Command line

## SYNOPSIS

man
man-clean
%man-com

## DESCRIPTION

man provides a mechanism to display a UNIX manual page within the MicroEmacs window. On invoking man the user is prompted for the name of the manual page to display:-

    Man on ?

The name of the manual page (and any options) are entered on the command line. The macro invokes the UNIX utility man(1) to generate the page and displays the results in a window. The man page executable may be defined with the variable %man-com this is defined as `man` by default.

Another manual page can be selected by either moving the cursor to the link and pressing return or double clicking on it with the left mouse button. MicroEmacs will then attempt to load and display the selected manual page.

man-clean removes any man-page formatting codes from the current buffer reducing a manual page to plain text. The formatting codes are used to create the bold and underline fonts. This allows the page to be treated as a normal buffer, i.e. string searches and other similar command will work as expected.

## NOTES

man and man-clean are macros defined in `hkman.emf`.

man is only made available within UNIX environments, the UNIX start up file `unixterm.emf` links in the macro. If the man utility is required on other platforms then the following definition is required in a start-up file.

    define-macro-file hkman man

On Microsoft Windows environments, if the cygwin directory is located then man is enabled and uses the cygwin man(1) utility and manual pages.

## SEE ALSO

man(1), man(9), cygwin(3), user-setup(3), spell-buffer(3).

(c) Copyright JASSPA 2009
Last Modified: 2009/08/29
Generated On: 2009/10/12

</HMTL>