manedit(1)

1ManEdit(1)            Integrated Development Environments           ManEdit(1)
2
3
4

NAME

6       manedit - UNIX Manual Page IDE
7

SYNTAX

9       manedit [section] [manual_page] [options] [GUI_options]
10

DESCRIPTION

12       ManEdit is an integrated UNIX manual page development environment (IDE)
13       using the GIMP Tool Kit (GTK).
14
15       Editing of UNIX manual pages is  done  using  ManEdit's  Editor,  which
16       edits  UNIX  manual pages using a simplified version of the XML format,
17       eliminating the need for the user to use the more  complex  GROFF/TROFF
18       format (native UNIX manual page format).
19
20       The  UNIX  manual  page  that you are editing can then be viewed at any
21       time using ManEdit's Viewer by going to View->Preview.
22
23       To start learning how to  create  and  edit  UNIX  manual  pages  using
24       ManEdit, run manedit and go to Help->Tutorial.
25
26       The  [section] specifies the section number from 1 to 8 (used only with
27       the --viewer option).
28
29       The [manual_page] specifies the path to the manual page file to open at
30       startup or the name of the manual page when using the --viewer option.
31

OPTIONS

33       --config <path>
34              Specifies the configuration file.
35
36       --rcfile
37              Same as --config.
38
39       -f     Same as --config.
40
41       --viewer
42              Specifies to start up with the Viewer.
43
44       --help Prints the help screen and exits.
45
46       --version
47              Prints the version information and exits.
48

FILES

50       $HOME/.maneditrc
51              Local configuration file.
52
53       /usr/share/manedit/
54              Global program directory.
55
56       /usr/share/manedit/help/
57              Help and tutorial files.
58
59       /usr/share/manedit/templates/
60              Manual  page  template files, used in the creation of new manual
61              pages.
62
63       /usr/man
64              Global manual pages directory.
65
66       /usr/share/man
67              Global manual pages directory  (used  by  newer  UNIX  distribu‐
68              tions).
69
70       /usr/share/man
71              Global X11 manual pages directory.
72
73       /usr/local/share/man
74              Global local manual pages directory.
75

ENVIRONMENT VARIABLES

77       BROWSER
78              Fallback for HELPBROWSER.
79
80       HELPBROWSER
81              Specifies the command to execute the preferred help browser.
82
83       HOME   Specifies the path to the user's home directory.
84
85       TMPDIR Specifies the path to the temporary files directory.
86
87       USER   Fallback for USERNAME.
88
89       USERNAME
90              Specifies the user's name.
91

EXAMPLES

93       To run this program the standard way, type:
94
95       # manedit &
96
97       To run this program and load a manual page at startup, type:
98
99       # manedit [manual_page] &
100
101       You can run it as a viewer by specifying the --viewer option so that it
102       starts up with a viewer instead of an editor window:
103
104       # manedit --viewer [manual_page] &
105

AUTHORS

107       Tara Milana
108              Head programmer
109
110       Dan Stimits
111              Programmer
112