home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 October / usenetsourcesnewsgroupsinfomagicoctober1994disk2.iso / misc / volume7 / gosip2 / README < prev    next >
Encoding:
Text File  |  1989-07-08  |  4.8 KB  |  108 lines
  1. APS Gosip
  2. =========
  3.  
  4. Gosip is a program that allows a user community to interchange lively debate,
  5. friendly banter, helpful insights, or anything else, by means of editing a
  6. globally writable (set of) file(s).  Gosip itself is also a term used to stand
  7. for any particular file's name, a bit like the shell meta character ``*''. [1]
  8.  
  9. The file 'History' gives some details on how the whole thing evolved, but the
  10. basic idea is that the compiled program is (hard-)linked to whatever files you
  11. wish to support, eg. help.  Then when anyone runs 'help', the program invokes
  12. an editor on the file text.help while ensuring exclusive access to that file.
  13.  
  14. Obviously the binaries need to be kept in a directory which is in every
  15. potential user's path.  Here at Warwick, we have a system called 'Newwords+'
  16. which provides not only gosip, but quite a few other extra commands written by
  17. the users for the user community.  It basically works by putting a
  18. subdirectory of the newwords+ administrator in every subscriber's path.
  19.  
  20. Contents
  21. ========
  22.  
  23. In the shar file you should find the source files edit.c main.c util.c lu.c
  24. history.c cat.c control.c with corresponding header files plus global.h.  Dw
  25. is a shell script that displays changes in gosip files [3], and finally setup
  26. is a shell program that installs gosip files (more below).
  27.  
  28. In addition, the following manual pages are supplied: allgoss.1, lu.1, dw.1,
  29. gosip.1.  Other documentation provided: README you already know about, History
  30. as mentioned above and notes, which is mainly a record of changes by version
  31. number.
  32.  
  33. Customisation
  34. =============
  35.  
  36. You will need to alter some file and directory names and other #define's:
  37.  
  38. (1)  In global.h, change DATA_FILE_DIRECTORY to a directory which you [will] 
  39.      own and which can be accessed by all potential gosip users.
  40.  
  41. (2)  Change SECRET_DIR to something not easily guessed.
  42.  
  43. (3)  In main.c, function init_file_names(), change the names of history and
  44.      last files (and lock files if used).  The history and last files should
  45.      not be edited directly by anyone: giving them unusual names in an
  46.      unreadable directory makes this less likely to occur.
  47.  
  48. (4)  In setup, change the definitions of the above accordingly. 
  49.  
  50. (5)  In control.h, you might like to specify yourself as the SUPER_USER.
  51.      SUPER_USER is the only one who can use the -# and -@ options, which are
  52.      used to deny or restore access to gosip (normally used when a new version
  53.      is being installed).  You might like to change DOWN_FILE as well.
  54.  
  55. (6)  In global.h, alter MAX_FILE_LENGTH to reflect your choice of file names.
  56.  
  57. For quite a while lockf() did not work on our system.  I have left in the
  58. previous locking code, based on lock files and flock(), which you can use if
  59. your lockf() is broken: add 'CFLAGS=-DLOCKF_BROKEN' to the makefile, and alter
  60. 'setup' so that DATA_FILE_DIRECTORY has global write permission.  [2]
  61.  
  62. The manual pages will need a few minor changes: you will need to alter the
  63. list of gosip files to specify those you choose to provide.
  64.  
  65. Of course, they may be lots of portability problems.  I don't know which
  66. system calls are specific to this version of UNIX (SunOS 4.0.1).
  67.  
  68. Installation
  69. ============
  70.  
  71. To install gosip, run "setup gosip", where gosip should be replaced with
  72. whatever files you wish to install.  Setup will create the directory for data
  73. files if it doesn't already exist - note that it must be owned by you.  The
  74. directory for data files should not be used to keep anything other than what
  75. gosip puts there.
  76.  
  77. Problems
  78. ========
  79.  
  80. As I've already said, I really don't know what system calls will or will not
  81. work on your system.  I will be pleased to receive bug reports or suggestions
  82. for modifications mailed to 'mauhk@uk.ac.warwick'.  However, since term ends
  83. on 1 July 1989 and I will go home then, I will not be able to reply to mail
  84. received after that date.  I do, though, expect to come back for a day at some
  85. point during the summer so I will still see any mail sent.
  86.  
  87. Andreas Pagel                        Magician, Programmer and Mathematician
  88. UUCP:   ...!mcvax!ukc!warwick!mauhk                   University of Warwick
  89. JANET:  mauhk@uk.ac.warwick                           Coventry
  90. ARPA:   mauhk%cu.warwick@nss.cs.ucl.ac.uk             Great Britain
  91.  
  92.  
  93. Footnotes
  94. =========
  95.  
  96. [1]  Gosip files used to be known as "the gossip files" in the manual pages
  97.      and colloquially.  When I rewrote gosip in C, I needed to compile test
  98.      versions.  Obviously I needed a name other than gossip by which to call
  99.      the binary, so I chose gosip.  From this, the current usage of gosip
  100.      arose.
  101.  
  102. [2]  I'm not sure whether this will suffice.  I haven't got time to test that
  103.      aspect, since I'm running out of time in which to post the program.
  104.  
  105. [3]  Dw's name comes from 'dw gosip' meaning "deal with gosip".  I understand
  106.      that Bourne shell functions are not universal, so this program may be
  107.      difficult to port to some systems.
  108.