manedit(1)

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

NAME

6       manedit - UNIX Manual Page IDE
7

SYNTAX

9       manedit [manual_page] [options] [GUI_options]
10
11       manedit --viewer [manual_page]
12

DESCRIPTION

14       ManEdit  is  a  UNIX Manual Page Integrated Development Environment. It
15       has full UNIX manual page editing capabilities using an  XML  interface
16       with instant preview. ManEdit uses the GTK+ widget set and requires the
17       X Window Systems.
18
19       In the ManEdit editor you can load one or more manual  pages  and  edit
20       each section using ManEdit's manual page format to XML translation fea‐
21       ture. Each manual page is broken down into sections and one header  for
22       easier  recognition  of  the manual page format.  If you are unfamiliar
23       with the XML or manual page formats, you  should  go  to  Help->How  To
24       Write ManPages.
25
26       In  viewer  mode,  you  can  search for an manual page installed in the
27       global manual page directories on the file system  ManEdit  is  running
28       on.  There  is  also an index feature which creates a complete catagory
29       index listing of all the manual pages installed on the file system (see
30       View->Index).
31
32       ManEdit  also  supports full Drag and Drop features between its process
33       windows, you can run ManEdit with multiple editor and viewer windows in
34       a single process.
35
36       The [manual_page] specifies the path to the manual page file to open at
37       startup.
38

OPTIONS

40       --config <file>
41              Open configuration from <file>.
42
43       --rcfile
44              Same as --config.
45
46       -f <file>
47              Same as --config.
48
49       --viewer
50              Start up with the Viewer.
51
52       --help Prints the help screen and exits.
53
54       --version
55              Prints the version information and exits.
56
57       Most other customizations can be performed in the preferences menu.
58

FILES

60       $HOME/.maneditrc
61              Local configuration file.
62
63       /usr/share/manedit/
64              Global program directory.
65
66       /usr/share/manedit/help/
67              Help and tutorial files.
68
69       /usr/share/manedit/templates/
70              Manual page template files, used in the creation of  new  manual
71              pages.
72
73       /usr/man
74              Global manual pages directory.
75
76       /usr/share/man
77              Global  manual  pages  directory  (used  by newer UNIX distribu‐
78              tions).
79
80       /usr/share/man
81              Global X11 manual pages directory.
82
83       /usr/local/share/man
84              Global local manual pages directory.
85

ENVIRONMENT VARIABLES

87       HOME   Specifies user's home directory.
88
89       USER   Specifies user's name (fallback from USERNAME).
90
91       USERNAME
92              Specifies user's name.
93

EXAMPLES

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

AUTHORS

109       http://wolfpack.twu.net/contacts.html
110