GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MANEDIT (1)

NAME

manedit - UNIX Manual Page IDE

CONTENTS

SYNTAX

manedit [section] [manual_page] [options] [GUI_options]

DESCRIPTION

ManEdit is an integrated UNIX manual page development environment (IDE) using the GIMP Tool Kit (GTK).

Editing of UNIX manual pages is done using ManEdit’s Editor, which edits UNIX manual pages using a simplified version of the XML format, eliminating the need for the user to use the more complex GROFF/TROFF format (native UNIX manual page format).

The UNIX manual page that you are editing can then be viewed at any time using ManEdit’s Viewer by going to View->Preview.

To start learning how to create and edit UNIX manual pages using ManEdit, run manedit and go to Help->Tutorial.

The [section] specifies the section number from 1 to 8 (used only with the --viewer option).

The [manual_page] specifies the path to the manual page file to open at startup or the name of the manual page when using the --viewer option.

OPTIONS

--config <path>
  Specifies the configuration file.
--rcfile
  Same as --config.
-f Same as --config.
--viewer
  Specifies to start up with the Viewer.
--help Prints the help screen and exits.
--version
  Prints the version information and exits.

FILES

$HOME/.maneditrc
  Local configuration file.
%%PREFIX%%/share/manedit/
  Global program directory.
%%PREFIX%%/share/manedit/help/
  Help and tutorial files.
%%PREFIX%%/share/manedit/templates/
  Manual page template files, used in the creation of new manual pages.
/usr/man
  Global manual pages directory.
/usr/share/man
  Global manual pages directory (used by newer UNIX distributions).
%%X11BASE%%/man
  Global X11 manual pages directory.
%%LOCALBASE%%/man
  Global local manual pages directory.

ENVIRONMENT VARIABLES

BROWSER
  Fallback for HELPBROWSER.
HELPBROWSER
  Specifies the command to execute the preferred help browser.
HOME Specifies the path to the user’s home directory.
TMPDIR Specifies the path to the temporary files directory.
USER Fallback for USERNAME.
USERNAME
  Specifies the user’s name.

EXAMPLES

To run this program the standard way, type:

# manedit &

To run this program and load a manual page at startup, type:

# manedit [manual_page] &

You can run it as a viewer by specifying the --viewer option so that it starts up with a viewer instead of an editor window:

# manedit --viewer [manual_page] &

AUTHORS

Tara Milana
  Head programmer
Dan Stimits
  Programmer

SEE ALSO

man(1) manview(1)

Search for    or go to Top of page |  Section 1 |  Main Index


WolfPack Entertainment MANEDIT (1) 1.2.1

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.