pkg://jmr-0.7.20.1.bin.ELF.tar.gz:172908/jmr-0.7.20.1/jmr.1  downloads

.\"	$Id: jmr.1,v 1.23 1998/05/25 20:05:59 jvuokko Exp $	
.\"
.\"
.\" Manual for jmr.
.\"
.\" Type 'groff -man -Tascii jmr.1 | more' to view this, if your system
.\" does not support man pages.
.\"
.\" You can build postscript version: 'groff -man -Tps jmr.1 > jmr.ps'
.\"
.\" Be warned that this document is under develping, and there are lot of
.\" empty paragraphs. 
.\"
.\"
.\" (c) 1997,1998 Copyright Jukka Vuokko
.\" ---------------------------------------------------------------------
.de Sh
.br
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Ip
.br
.ie \\n.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.\"
.\"
.\"
.TH JMR 1 "23 Apr 1998" "JMR 0.7.18.0 (ALPHA)" "jmr QWK offline mail reader"
.SH "NAME"
jmr \- A QWK offline mail reader.

.SH "SYNOPSIS"
jmr [\-chl] [\-f resoure_file] [\-\-help] [\-\-color] [\-\-licence]
[\-\-rcfile resource_file] [--init]
.PP
Where 
.I resource_file 
is name of special resource file in jmr's directory.
.PP
.\"
.\"
.SH "DESCRIPTION"
.\"
.\"
.I Jmr
is a full-screen, easy to use offline mail reader for
use with
.I QWK
compatible mail packets.
.\"
.\"
.PP
.SH "FEATURES"
.\"
.\"
.IP \(bu 
Thread support. 
.IP \(bu
Reply logging.  Jmr creates a group for all of your outgoing messages
and lets you keep as many as you like.  Replies can be deleted
individually, or you can specify a maximum count, and jmr will remove
messages automatically.
.IP \(bu
Message database. All articles are stored to database, and them are kept
in database until maximum count of articles is reached. Then oldest articles
are removed. If you want that all articles will be stored for ever, specify
huge maximum count, e.g. 100000000.
.IP \(bu
Articles can be tagged for later action using tag-command. This places a
reference to article to group 'Tagged Articles'. Article is keeped in group
'Tagged Articles' as long as reference article exist in the database.

This is very handy if article is crying out for a followup, but you wish
to do so at a later time.
.IP \(bu
Article or thread can be saved to a file.
.IP \(bu
You can use your favorite editor (say emacs) with jmr .
.IP \(bu
You can read and sort messages by thread, subject, date/time, writer
and receiver.
.IP \(bu
Message can be entered for a target BBS, even if no packet for that
BBS exists (but BBS must have been read at least once with jmr).
.IP \(bu
Jmr will support up to 9000 groups per BBS and unlimited count of  messages 
per every group.
.IP \(bu
Supports color and mono terminals. 
.IP \(bu 
Jmr supports PCBOARD's long subjects.
.IP \(bu
Simple addressbook.
.IP \(bu 
Color highlight for different part of articles.
.IP \(bu
Random taglines
.IP \(bu
Characterset conversions.
.IP \(bu 
Jmr will be available for Linux and other Unix-variants, OS/2, DOS and
Win32-console. 
.IP \(bu 
Jmr reads size of terminal and uses it. Manual configuration is not needed.
.PP
.SH "ENVIRONMENT"
.I Jmr 
looks for environment two variables HOME and JMRDIR.

The variable 
.I HOME
is most important. By default \fIjmr\fP creates directory $HOME/.jmr/ for
storing all necessary data (logs etc.).

With variable 
.I JMRDIR
you can specify directory path different than $HOME/.jmr/ if you wish,
and \fIjmr\fP will set up it's files there. Generally you would want the
JMRDIR environment variable to be a path to a subdirectory off of your
home directory.

On non-unix systems that does not use home directories for individual
users, it might be a good idea to specify directory using JMRDIR.

Note that paths cannot be ralative, and if your system uses
drive-letters (like MS-DOG), path must start with
drive-letter. e.g. in Unix systems JMRDIR might be something 
like: ~/work/mail/ and in DOS-familian systems it might be: c:\\work\\mail\\

.\"
.\"
.SH "SYSTEM REQUIREMENTS"
.\"
.\"
On 
.I Unix-like 
systems \fIjmr\fP
requires at least VT100 terminal to run. On
.I OS/2
, 
.I DOS
and 
.I Win32 
jmr needs ansi-support (something like ANSI.SYS-driver) to run
correctly. On 
.I DOS
jmr needs also DOS4GW-extender or Go32-extender,
depending on distribution version.
.\"
.\"
.SH "CONFIGURATION"
.\"
.\"
When you start \fIjmr\fP first time, it creates resource file
.I jmrrc
to it's directory and informs you about it. 

Check that all settings in that file are correct, and modify them if
necessary. At least you need to specify path to qwk packets and path to
replies.

All settings are documented in resource file, so read it
carefully.

If something goes wrong, you can allways create new file by deleting
existing file, or executing \fIjmr\fP with option --init.
.\"
.\"
.SH "OPTIONS"
.\"
.\"
.TP 10
.BI -f " file" 
.TP 15
.BI --rcfile " file"
Specify name of resource file, if not jmrrc. File must be in jmr's
directory (i.e. in directory that environment variable 
.I JMRDIR
points or in directory 
.I $HOME/.jmr/
).
.TP 15
.BI "-h, --help"
Show short help.
.TP 15
.BI "-c, --color"
Use ANSI-colors regardless of terminals termcap capabilities. This is useful 
if you use \fIjmr\fP in color-xterm. That's because color-xterm is capable to show 
colors, but it uses same termcap entry with normal xterm.
.TP 15
.BI "--init"
Create new resource file with default settings.
.TP 15
.BI "-l, --licence"
Show licence of \fIjmr\fP.
.\"
.\"
.SH "SHORT OVERVIEW ABOUT JMR"
.\"
.\"
\fIjmr\fP has four separate levels of operation. Top level is 
.I "Mail Packet Selection Level"
, then comes 
.I "Group Selection Level"
, 
.I "Thread Selection Level"
and 
.I "Message Viewing Level."

At the Mail Packet Selection Level \fIjmr\fP shows list of all available
message databases or list of all available mail packets, and you can select
one of them to read. 

At the Group Selection Level \fIjmr\fP shows all groups with new messages, and you
can select group to read. Four first has special meaning, they are jmr's
.I basegroups.
First group contains all messages for you, second group contains all
replies that you have wrote to current BBS. Third group contains new
replies, and fourth group contains tagged articles.

At the Thread Level \fIjmr\fP displays all unread threads of current group. Screen
format is somewhat like this:
.PP
.RS
.nf
0   4  What is jmr?                    [John Smith ]
1   1  Problem with gcc and templates  [Real Coder ]
.fi
.RE
.PP
Where first field is index of group, then comes number of unread messages
within thread. Third field is subject of thread, and last is name of author
of thread's first article.

At the Message Level \fIjmr\fP displays messages's header
information (subject, author, receiver etc.), and body of message.

More detailed information below in chapter 'USING JMR'.
.\"
.\"
.SH "KEYBOARD COMMANDS"
.\"
.\"
.Sh "COMMON MOVING COMMANDS"
.\"
.\"
This table shows the common keys/commands for moving at all levels
within \fIjmr\fP.
.TP 12
.B Home, <
Beginning of list/article.
.TP 12
.B End, >
End of list/article.
.TP 12
.B "PgUp, b"
Page up.
.TP 12
.B "PgDn, SPC"
Page down.
.TP 12
.B "Up arrow"
Line up.
.TP 12
.B "Down arrow"
Line down.
.PP
.\"
.\"
.Sh "COMMON EDITING COMMANDS"
.\"
.\"
Line editor accepts some emacs style commands:
.TP 10
\fB^A,^E\fP
Move to beginning or end of line.
.TP
\fB^K\fP
Delete all characters, from cursor to end of line. 
.TP
\fB^H, BS\fP
Delete the previous character.
.TP
\fB^B, ^F\fP
Move backward or forward.
.TP
\fB^L\fP
Redraw.
.\"
.\"
.Sh "MAIL PACKET SELECTION COMMANDS"
.\"
.\"
.TP 10
\fBr\fP
Refresh file list.
.TP
.B n
Next packet.
.TP
.B p
Previous packet.
.TP
\fBCR\fP
Open mail packet.
.TP
\fBl\fP
List available mail packets or list available message databases.
.TP
\fB^L\fP
Redraw page.
.TP
\fBq\fP
Quit jmr.
.\"
.\"
.Sh "GROUP SELECTION COMMANDS"
.\"
.\"
.TP 10
.B n
Next group.
.TP
.B p
Previous group.
.TP
.B CR, ->
Select group.
.TP
.B TAB
Select next group with unread messages.
.TP
.B w
Write an article to current group.
.TP
.B y
Switch between all groups and groups with unread messages.
.TP
.B c
Catchup. Mark all articles in current group as read.
.TP
.B q
Back to mail packet selection level.
.\"
.\"
.Sh "THREAD SELECTION COMMANDS"
.\"
.\"
.TP 10
.B n 
Next thread.
.TP
.B p
Previous thread.
.TP
.B TAB
View next unread article within all threads.
.TP
.B CR
View first article of current thread.
.TP
.B w
Write an article to current group.
.TP
.B f
Write followup to current article (or when reading mode is by threads, to
first article of current thread).
.TP
.B r
Write private reply current article (or first article of current thread).
.TP
.B y
Show all threads or only threads with unread articles.
.TP
.B t
Tag current article (or first article of current thread). This does not
work in jmr's basegroups (Replylog, New Replies, ...).
.TP
.B T
Tag/untag all articles (not in thread mode).
.TP
.B s
Sort articles. Available sort orders are: thread (default), subject, date,
receiver and author.
.TP
.B c
Catchup. Mark all articles of current group as a read.
.TP
.B e
Edit current reply. Works only in group 
.I New replies.
.TP
.B k
Kill article. Works only in groups
.I Replylog, New Replies 
and 
.I Tagged Articles.
.TP
.B q, <- 
Back to group selection level.
.TP
.B ^L
Redraw page.
.\"
.\"
.Sh "MESSAGE VIEWER COMMANDS"
.\"
.\"
.TP 10
.B TAB, CR
View next unread article within current group.
.TP
.B n, ->
View next article.
.TP
.B p
View previous article.
.TP
.B N
Next article in history.
.TP
.B P
Previous article in history.
.TP
.B f
Write followup to current article.
.TP
.B r
Write private reply to current article.
.TP
.B t
Tag current article.
.TP
.B k
Kill current article. Only in groups Replylog, New Replies and Tagged
Articles.
.TP
.B s
Save current article or thread to file.
.TP 
.B SP
Page down, or if end of current article, then view next unread article.
.TP
.B ESC-r
View article using ROT13-encryption.
.TP
.B ESC-w
Toggle line wrapping mode on/off.
.TP
.B q, <-
Back to thread selection level.
.TP
.B ^L
Redraw page.
.\"
.\"
.SH "USING JMR"
.\"
.\"
This section is still under developing :-)
.\"
.\"
.SH "FILES"
.\"
.\"
.Sh "Files in $JMRDIR or $HOME/.jmr"
.TP 12
.B jmrrc
The 
.I jmr's
initialization file.
.TP 12
.B <bbsid>.rc
BBS related resource file. See /usr/local/lib/jmr/sample.rc for more 
information.
.TP 12
.B mailrc
The addressbook file. If you want to use addressbook, then create this
file and fill it with addresses. One address per one line.
.TP 
.B reply.msg
Latest message you've written. 

It is also possible that your editor creates some backupfiles in jmr's
directory. And if editor or \fIjmr\fP crashes when you're editing a reply, then
your editor hopefully saves reply to it's emergency file.

For example, Joe stores message to file 
.I deadjoe
, jed and emacs to file
.I #reply.msg
if process is terminated.
.PP
.Sh "Files in subdirectory 'data'"
In this subdirectory 
.I Jmr
keeps several files for each BBS. These files are Replylogs,
and message databases.

The files are named using format bbsid.xxx, where
.I bbsid
is BBS's id-string and 
.I xxx 
is type of file:
.TP 12
.B bbsid.log
Replylog of BBS.
.TP
.B bbsid.gdb
Group database. 
.TP
.B bbsid.mdb
Message database.

.Sh "Files in subdirectory 'work'"
This is the directory where QWK-packet and old replypacket is extracted.

\fIjmr\fP will also save new replies to file
.I deadjmr.msg
in this directory, If terminate signal is received.
Then on next startup, \fIjmr\fP asks if user want to continue with 
these replies.

If session was killed, then ID-code of bbs is writed to file 
.I deadjmr.id
.\"
.\"
.SH "DIAGNOSTICS"
.\"
.\"
.\"
.\"
.SH "BUGS"
.\"
.\"
See file BUGS.
.\"
.\"
.\"
.\"
.SH "COPYING AND NO WARRANTY"
.\"
.\"
Copyright (C) 1997,1998 Jukka Vuokko
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
.\"
.\"
.SH "SEE ALSO"
.\"
.\"
See files 
.I README,
.I COPYING,
.I TODO,
.I BUGS
and
.I CHANGES
to get latest information. These files should be in directory
/usr/local/lib/jmr/.
.PP
Latest version and c++ source code for 
.I jmr
is available at jmr's homepage: 
.B http://www.iki.fi/jvuokko/jmr/
.\"
.\"
.SH "AUTHOR"
.\"
.\"
Jukka Vuokko <jvuokko@iki.fi>
.SH "THANKS"
.\"
.\"
(In alphabetical order)
.PP
Dirk Bernhardt
.PP
Yrjo Hatakka
.PP
Jari Kaasalainen
.PP
Jukka Lahtinen
.PP
Lauri Liuhto
.PP
Jarmo Muukka
.PP
Hannu Okkola
.PP
Teemu Pohjolainen
.PP
Markku Raasakka
.PP
Juhana Venalainen
.PP
Ilkka Virta