home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Internet Tools 1993 July / Internet Tools.iso / RockRidge / news / misc / eep / eep1_9 / eep.1 next >
Encoding:
Text File  |  1993-03-22  |  8.0 KB  |  302 lines
  1. .SH NAME
  2. EEP! v1.9 -- Easy Editor Program for .newsrc files
  3. .SH SYNOPSIS
  4. .B eep [-d][-n][-p][-v]
  5. .PP
  6. .SH DESCRIPTION
  7. .I Eep\^
  8. is a user-friendly full-screen editor designed to 
  9. modify the .newsrc file associated with the
  10. .B rn
  11. or
  12. .B trn
  13. news readers.  It is NOT intended to be used while the .newsrc
  14. is currently open, i.e. by shelling out.  It may also work
  15. with 
  16. .B nn.
  17. .P
  18. If you read news on a network that supports NNTP (Network News
  19. Transfer Protocol) EEP! may be compiled to make use of the
  20. NNTP server on your network.
  21. .P
  22. EEP starts by building a list of newsgroups taken either from 
  23. the NNTP server or your
  24. .I /usr/lib/news/active 
  25. file, which is supplied with the `B' or `C' news software.  
  26. This will be merged with descriptions taken from 
  27. .I /usr/lib/news/newsgroups 
  28. and 
  29. .I /usr/lib/news/newslocal,
  30. or the NNTP server if this is selected.
  31. .P
  32. EEP will then read the .newsrc file from the $HOME directory
  33. of the user, and will display the list with a '+' sign marking
  34. subscribed newsgroups.  (If $DOTDIR is defined, this will be 
  35. used instead of $HOME).
  36. .P
  37. Curses is used to draw a list of the newsgroups, which may be
  38. navigated using arrow keys as well as commands similar to the 
  39. .B vi
  40. editor.  Newsgroups which are currently subscribed to will be
  41. prefixed with a ``+'' character, while those not subscribed to 
  42. will have a SPACE.  If the newsgroup is invalid in same way, e.g.
  43. it is bogus (not known in the active file) it will be marked with
  44. a ``?''.  Pressing the 'i' key will show further information about 
  45. the highlighted newsgroup, including its position in the file, low
  46. and high message numbers, and whether it is active, inactive or
  47. moderated.  Other commands allow the user to subscribe or
  48. unsubscribe to newsgroups, delete them from their .newsrc
  49. or catch up (mark all messages as read).
  50. .P
  51. If articles exist in the highlighted newsgroup, the `v' command
  52. may be used to view a list of headers, allowing users to
  53. browse through the messages (but not the message text.)
  54. .P
  55. After certain commands, the cursor will automatically advance to
  56. the next or previous newsgroup, depending upon the direction of
  57. travel, as indicated with the most recent up or down movement.
  58. .P
  59. .SH
  60. COMMANDS
  61. .P
  62. Here is a summary of commands available (upper and lower case
  63. letters are treated the same.)  Note that some commands have more
  64. than one character to activate them, to offer variety of choice.
  65. .P
  66. .B Movement
  67. .nf
  68.  
  69.    ^n         )    Move pointer down one line
  70.    SPACE      )
  71.    j          )
  72.    Down_Arrow )
  73.  
  74.    ^p         )    Move pointer up one line
  75.    BACKSPACE  )
  76.    k          )
  77.    Up_Arrow   )
  78.  
  79.    ^d         )    Move pointer down one page
  80.    ^f         )
  81.  
  82.    ^u         )    Move pointer up one page
  83.    ^b         )
  84.  
  85.    t          )    Move to top of file
  86.    ^          )
  87.  
  88.    b          )    Move to bottom of file
  89.    $          )
  90.  
  91.    Left_Arrow )    Less newsgroup and more description shown
  92.    <          )
  93.  
  94.    Right_Arrow)    More newsgroup and less description shown
  95.    >          )
  96.  
  97.    :          )    Select newsgroup by number
  98. .fi
  99. .PP
  100. .B Searching
  101. .P
  102. There are two styles of searching, 
  103. .B vi
  104. and
  105. .B emacs.
  106. .PP
  107. .B vi
  108. style searching will occur in the direction of the last cursor movement 
  109. (default downwards.)  Searching for a null string will repeat the
  110. last search, which is identical to the 'n' command.
  111. .PP
  112. .B emacs
  113. style searching will go forwards or backwards, depending upon the command.
  114. Terminate the search with ESCAPE, and use backspace to erase the last
  115. character in the search string.  Pressing ^S or ^R again will repeat the
  116. last search.
  117. .nf
  118.  
  119.    /          )    Search for string of text, vi style
  120.  
  121.    n          )    Search again
  122.  
  123.    ^S         )    Incremental search, EMACS style (ESC to stop)
  124.  
  125.    ^R         )    Reverse search, EMACS style
  126. .fi
  127. .PP
  128. .B Subscription
  129. .nf
  130.  
  131.    s          )    Subscribe to current newsgroup
  132.    +          )
  133.  
  134.    u          )    Unsubscribe to current newsgroup
  135.    -          )
  136.  
  137. .fi
  138. .PP
  139. .B Sorting
  140. .nf
  141.    a          )    Toggle: Alphabetise the list or back to .newsrc order
  142.  
  143.    o          )    Organize with subscribed groups at top
  144. .PP
  145. .B Other
  146. .nf
  147.  
  148.    ?          )    Display help screen
  149.    h          )
  150.    F1         )
  151.  
  152.    p          )    Change type of pointer
  153.  
  154.  
  155.    c          )    Catch up (mark all messages as read)
  156.  
  157.    .          )    Toggle mark.  This is used to select
  158.                    groups to be moved with the (m) Move
  159.                    command.
  160.  
  161.    m          )    Move marked groups to current position.
  162.  
  163.    i          )    Show more information on newsgroup
  164.  
  165.    r          )    Redraw screen
  166.    ^L         )
  167.  
  168.    v          )    View list of messages in newsgroup
  169.    =          )
  170.    ENTER      )
  171. .fi
  172. .PP
  173. .B Exit  
  174. .nf
  175.  
  176.    q          )    Quit without saving changes
  177.    ESC        )
  178.    ^C         )
  179.    DEL        )
  180.  
  181.    x          )    Exit and save changes
  182. .fi
  183. .PP
  184. .B Alphabetic list of commands:
  185. .nf
  186.  
  187. ^B    Move up a screenful
  188. ^C    Quit without saving
  189. ^D    Move down a screenful
  190. ^F    Move down a screenful
  191. ^H       Move cursor up one line (backspace)
  192. ^J    View list of articles in newsgroup (ENTER key)
  193. ^L    Redraw screen
  194. ^N    Move cursor down one line
  195. ^P    Move cursor up one line
  196. ^R      Reverse search, EMACS-style
  197. ^S      Incremental search, EMACS-style (stop with ESCAPE)
  198. ^U    Move up a screenful
  199. ESC    Quit without saving (also ^[)
  200. SPACE    Move cursor down one line
  201. ^    Goto top of file
  202. $    Goto bottom of file
  203. .    Mark newsgroup for movement
  204. =    View list of articles in newsgroup
  205. /    Search for text
  206. :    Jump to newsgroup by number
  207. +    Subscribe
  208. -    Unsubscribe
  209. <       Slide view to left (also left arrow key)
  210. >       Slide view to right (also right arrow key)
  211. ?    Help
  212. F1    Help (function key dependent)
  213.  
  214. a    Alphabetize (sort) toggle
  215. b    Goto bottom of file
  216. c    Catch up messages
  217. h    Help
  218. i    Information on newsgroup
  219. j    Move downwards one line
  220. k    Move upwards one line
  221. m    Move a set of marked newsgroups to cursor
  222. n    Search for next occurence
  223. o       Organize with subscribed groups over others
  224. p    Toggle pointer type
  225. q    Quit without making changes
  226. r    Redraw screen
  227. s    Subscribe
  228. t    Goto top of file
  229. u    Unsubscribe
  230. v    View list of articles in newsgroup
  231. x    Exit and save changes
  232.  
  233. .fi
  234. .PP
  235. Options are:
  236. .TP 1.0i
  237. .B "  -d"
  238. Delete unsubscribed newsgroups from the .newsrc.  The normal behaviour
  239. is to leave these untouched.
  240.  
  241. .B "  -n"
  242. Disable NNTP connection.  Note that if NNTP is selected when EEP!
  243. is compiled, it will use the NNTP server to get the
  244. .I active
  245. file or the
  246. .I newsgroups
  247. file.
  248.  
  249. .B "  -p"
  250. Change the pointer used from scroll bar to simple arrow.  This is
  251. faster at low modem speeds when moving through the file.
  252.  
  253. .B "  -v"
  254. Verbose mode will tell you more about EEP during startup.
  255.  
  256. .SH AUTHOR
  257. Paul Gillingwater, Actrix Information Exchange <paul@actrix.gen.nz>
  258. .SH WARNINGS
  259. Your existing .newsrc will be renamed to .newsrc.old, deleting any
  260. existing file of that name.  This will occur only when you exit with
  261. the
  262. .B "``x''"
  263. command.  Until then,
  264. .B "eep's"
  265. working file is .newsrc.new.
  266. .P
  267. New newsgroups will not automatically be notified.  Newsgroups 
  268. which are not present in your .newsrc file, but are found in the
  269. active file, will be sorted to the bottom of the list.
  270. .P
  271. When moving a set of newsgroups with the mark and move commands,
  272. the set will not necessarily stay in the same relative order.
  273. .P
  274. Bogus newsgroups (those not found in the active file, but present
  275. in your .newsrc) will be (optionally) deleted.  Deleting newsgroups
  276. is pointless, because if they're in the active file, then they will
  277. automatically be added in next time you run 
  278. .B eep.
  279. .P
  280. When subscribing or marking the first or last newsgroups, and
  281. the direction of movement would not move the cursor, the line
  282. is not updated as it should be.
  283. .SH FILES
  284. $HOME/.newsrc                 file to be modified
  285. .br
  286. $HOME/.newsrc.old             backup of previous .newsrc
  287. .br
  288. $HOME/.newsrc.eep             temporary working file
  289. .br
  290. $HOME/.rnlock                 lock file used with rn
  291. .br
  292. /usr/lib/news/newsgroups      } names and descriptions 
  293. .br
  294. /usr/lib/news/newslocal       } of newsgroups
  295. .br
  296. /usr/lib/news/active          active newsgroups file
  297. .SH BUG REPORTS TO
  298. Paul Gillingwater <paul@actrix.co.at>
  299. .SH COPYRIGHTS
  300. .ps 18
  301. \fB\(co\fR\s12 Copyright 1991-1993 by Paul Gillingwater
  302.