From 492e7d80c46adaf4a125d67ef25994422433a99a Mon Sep 17 00:00:00 2001 From: Yevgen Muntyan <17531749+muntyan@users.noreply.github.com> Date: Wed, 20 Jun 2007 02:26:14 -0500 Subject: [PATCH] Added man page --- debian/medit.1 | 56 --------------------------------------- medit/Makefile.am | 3 +++ medit/medit.1 | 67 +++++++++++++++++++++++++++++++++++++++++++++++ moo.mprj | 4 +-- 4 files changed, 72 insertions(+), 58 deletions(-) delete mode 100644 debian/medit.1 create mode 100644 medit/medit.1 diff --git a/debian/medit.1 b/debian/medit.1 deleted file mode 100644 index 8e5d5a67..00000000 --- a/debian/medit.1 +++ /dev/null @@ -1,56 +0,0 @@ -.\" Hey, EMACS: -*- nroff -*- -.\" First parameter, NAME, should be all caps -.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection -.\" other parameters are allowed: see man(7), man(1) -.TH MEDIT SECTION "April 30, 2006" -.\" Please adjust this date whenever revising the manpage. -.\" -.\" Some roff macros, for reference: -.\" .nh disable hyphenation -.\" .hy enable hyphenation -.\" .ad l left justify -.\" .ad b justify to both left and right margins -.\" .nf disable filling -.\" .fi enable filling -.\" .br insert line break -.\" .sp insert n+1 empty lines -.\" for manpage-specific macros, see man(7) -.SH NAME -medit \- program to do something -.SH SYNOPSIS -.B medit -.RI [ options ] " files" ... -.br -.B bar -.RI [ options ] " files" ... -.SH DESCRIPTION -This manual page documents briefly the -.B medit -and -.B bar -commands. -.PP -.\" TeX users may be more comfortable with the \fB\fP and -.\" \fI\fP escape sequences to invode bold face and italics, -.\" respectively. -\fBmedit\fP is a program that... -.SH OPTIONS -These programs follow the usual GNU command line syntax, with long -options starting with two dashes (`-'). -A summary of options is included below. -For a complete description, see the Info files. -.TP -.B \-h, \-\-help -Show summary of options. -.TP -.B \-v, \-\-version -Show version of program. -.SH SEE ALSO -.BR bar (1), -.BR baz (1). -.br -The programs are documented fully by -.IR "The Rise and Fall of a Fooish Bar" , -available via the Info system. -.SH AUTHOR -medit was written by Yevgen Muntyan . diff --git a/medit/Makefile.am b/medit/Makefile.am index a8bd6e8a..5302c3eb 100644 --- a/medit/Makefile.am +++ b/medit/Makefile.am @@ -5,9 +5,12 @@ AM_CFLAGS = \ $(MOO_DEBUG_CFLAGS) EXTRA_DIST = \ + medit.1 \ medit-app.opag \ medit.rc.in +man_MANS = medit.1 + all-am: medit.iss bin_PROGRAMS = medit diff --git a/medit/medit.1 b/medit/medit.1 new file mode 100644 index 00000000..4c8f3c86 --- /dev/null +++ b/medit/medit.1 @@ -0,0 +1,67 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH MEDIT 1 "June 20, 2007" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +medit \- text editor +.SH SYNOPSIS +.B medit +.RI [ options ]\ [ files ] +.SH DESCRIPTION +.B medit +is a text editor. +.SH OPTIONS +.TP +.B \-h, \-\-help +Show summary of options. +.TP +.B \-v, \-\-version +Show version of the program. +.TP +.B \-n, \-\-new\-app +Run new instance of \fBmedit\fP. By default \fBmedit\fP opens \fBfiles\fP +in an existing instance of application. +.TP +.B \-\-pid PID +Use existing instance with process id \fBPID\fP. +.TP +.B \-l, \-\-line LINE +Open file and position cursor on line \fBLINE\fP. +.TP +.B \-\-log[=FILE] +Show debug output or write it to \fBFILE\fP. +.TP +.B \-\-debug +Run in debug mode. +.TP +.B \-\-exec STRING +Execute python code in an existing instance. +.TP +.B \-\-exec\-file FILE +Execute python file in an existing instance. +.TP +.B files +List of files to open. Filenames may include line numbers after colon, e.g. /tmp/file.txt:200. +.SH ENVIRONMENT +.TP +.B MEDIT_PID +If set, used as --pid argument. When medit spawns a process (e.g. a DVI viewer) it sets MEDIT_PID +to its own process id, so the child process may in turn simply use 'medit filename' to open a file +(e.g. for inverse DVI search). +.SH CONTACT +http://mooedit.sourceforge.net/contact.html. +.SH AUTHOR +medit was written by Yevgen Muntyan . diff --git a/moo.mprj b/moo.mprj index 39a54641..41533289 100644 --- a/moo.mprj +++ b/moo.mprj @@ -5,7 +5,7 @@ build/debug - --enable-debug=full --enable-all-warnings --enable-libmoo --with-mooterm --enable-libmoo-headers --enable-project --enable-canvas + --enable-debug=full --enable-all-warnings --enable-libmoo --with-mooterm --enable-project --enable-canvas -g @@ -34,7 +34,7 @@ - /home/muntyan/projects/moo/moo/mooapp/ + /home/muntyan/projects/moo/moo/ --new-app /tmp/file.rst medit/medit