home *** CD-ROM | disk | FTP | other *** search
/ Netscape Plug-Ins Developer's Kit / Netscape_Plug-Ins_Developers_Kit.iso / SOFTWARE / lsoft / unix / common.tz / common / u-install.memo < prev   
Encoding:
Text File  |  1994-08-01  |  39.6 KB  |  814 lines

  1.  
  2.  
  3.                Installation guide for LISTSERV for UNIX(R)
  4.                -------------------------------------------
  5.                   Copyright L-Soft International, 1994
  6.                          Last update: 31 Jul 94
  7.  
  8.  
  9. *************************************************************************
  10. ***********    Condensed Summary of Installation Procedure    ***********
  11. *************************************************************************
  12. *                                                                       *
  13. *   1. Create the listserv account                                      *
  14. *   2. Uncompress and un-tar the archive files                          *
  15. *   3. Customize the  Makefile                                          *
  16. *   4. Enter 'make mailer'                                              *
  17. *   5. Enter 'make server'                                              *
  18. *   6. Enter 'make lcmd'                                                *
  19. *   7. Enter 'make install'                                             *
  20. *   8. Customize the "go" shell script                                  *
  21. *   9. Enter 'make aliases' or update sendmail manually                 *
  22. *  10. Make license-key information available to your server            *
  23. *  11. Start LISTSERV!                                                  *
  24. *  12. Subscribe to the LSTSRV-E mailing list                           *
  25. *  13. Make your server known to the other LISTSERV's                   *
  26. *                                                                       *
  27. *************************************************************************
  28.  
  29. ************
  30. * Overview *
  31. ************
  32.  
  33. If you're  very familiar with software  installations on your  system and
  34. would  prefer  terse,    matter  of  fact  hints   rather  than  complete
  35. instructions,   skip  to  the  section entitled  "The  Bare  Facts  About
  36. Installing LISTSERV" at the end of this document.
  37.  
  38. LISTSERV  for UNIX(R)   is distributed  as two  compressed "tar"  archive
  39. files.  The  installation guide,   which is  the file  you are  currently
  40. reading, is also available independently of the archives.  One of the tar
  41. files contains data  files common to LISTSERV on  all UNIX(R)  platforms,
  42. and the other contains the compiled  version of the LISTSERV server.   In
  43. order to simplify the process of removing extraneous files created during
  44. the installation  procedure,  you  can copy  the tar  files to  a scratch
  45. directory,   install  LISTSERV,   and  then   "rm -fr /tmp/scratch"   (or
  46. whatever you name the staging area).
  47.  
  48. The installation of LISTSERV consists of the following steps,
  49.  
  50. - creating a "listserv" username,
  51.  
  52. - extracting the files in the two archive files,
  53.  
  54. - deciding what directories you want used  for incoming mail,  as well as
  55.   for the LISTSERV program and data files,
  56.  
  57. - running "make" to create the LISTSERV sendmail interface,  command line
  58.   interface, and LISTSERV server programs,
  59.  
  60. - running  "make install"  to create the necessary directories,  and copy
  61.   the programs generated in the previous "make" to the proper places,
  62.  
  63. - modifying  the  "go.user"  shell script  to  accurately  describe  your
  64.   system,
  65.  
  66. - appending entries to your /etc/aliases file to handle mail sent to your
  67.   LISTSERV username,   and direct  your sendmail  daemon to  use the  new
  68.   aliases,
  69.  
  70. - creating  a  "license.merge"  file  to  make  license  key  information
  71.   available to your server,
  72.  
  73. - subscribing  to  the  LSTSRV-E  forum  to  join  others  in  discussing
  74.   experiences with the evaluation copies of LISTSERV,
  75.  
  76. - and finally,  fill out and return  (via e-mail)  information about your
  77.   LISTSERV so that  other LISTSERV's around the Internet  will know about
  78.   your server.
  79.  
  80. All of these steps are described in greater detail in the sections below.
  81. They should be performed in the order they are presented since some steps
  82. rely on  the results of earlier  steps.   Once you've finished  the above
  83. steps,  you  will be  able to start  your LISTSERV  and verify  that it's
  84. working.   You'll then  be ready to create mailing lists  and start using
  85. your LISTSERV.
  86.  
  87. ********************************
  88. * Usernames needed by LISTSERV *
  89. ********************************
  90.  
  91. LISTSERV requires  exclusive access  to the  mail sent  to one  username.
  92. Unless  you have  a  very  good reason  to  do  otherwise,  the  username
  93. "listserv" should be used for that purpose.  Many people around the world
  94. are already  familiar with LISTSERV,  and  will assume that mail  sent to
  95. <listserv@your.host.name> will reach the server.  The LISTSERV account is
  96. just an ordinary user, it doesn't need privileges, doesn't require access
  97. to restricted directories, and it doesn't need to have any particular UID
  98. or GID.
  99.  
  100. **********************************************************
  101. * Extracting installation materials from the "tar" files *
  102. **********************************************************
  103.  
  104. The two archive files you receive  will be called common.tar.Z and either
  105. AIX.tar.Z,  or SunOS.tar.Z,  or ULTRIX.tar.Z,   etc...   depending on the
  106. version of UNIX(R) you are using.   The filename is taken from the string
  107. returned by the "uname" command on  each UNIX(R)  platform.   Please note
  108. that some FTP sites  may change the name of the  files slightly to adhere
  109. to system specific  naming conventions.   If you're used  to dealing with
  110. compressed  tar files  already,   then just  extract  the contents  using
  111. whatever commands you prefer.   If you'd  like the sample commands listed
  112. below to work as shown, rename the files you received to common.tar.Z and
  113. `uname`.tar.Z before continuing.    For example,  if the  system specific
  114. file  you received  is called  aix.tar-z,   you would  enter the  command
  115. mv aix.tar-z `uname`.tar.Z.   Copy  or move  the two  files to  a scratch
  116. directory  first.  (The  advantage  of using  a  work  directory for  the
  117. installation is that you can easily clean up afterwards.)  Once the files
  118. have been copied,  "cd" to that directory and enter,  uncompress *.tar.Z
  119. to restore them to their original state.  Then enter,  tar xf common.tar
  120. and  tar xf `uname`.tar  to  unbundle the programs,  data  files,  etc...
  121. needed to  install LISTSERV.   Afterwards you  should find  the following
  122. files have been created in your current directory,
  123.  
  124. lsv.o  Makefile  go  go.sys  go.user.sample  u-install.memo
  125. lsv_amin.c  lcmd.c
  126.  
  127. and the ./home directory will contain the following files.
  128.  
  129. bitearn.nodes    listall.refcard  listmast.memo    peers.names
  130. country.file     listfile.memo    listownr.memo    service.names
  131. default.mailtpl  listjob.memo     listpres.memo    stdcmd.file
  132. errfac.file      listkeyw.memo    listserv.memo    sysff.file
  133. intpeers.names   listkwd.file     lsvhelp.file     system.catalog
  134. linkswt2.file    listlpun.memo    lsvinfo.file
  135.  
  136. Sample commands for this step:
  137.      mkdir /tmp/scratch
  138.      cp common.tar.Z `uname`.tar.Z /tmp/scratch
  139.      cd /tmp/scratch
  140.      uncompress *.Z
  141.      tar xf common.tar
  142.      tar xf `uname`.tar
  143.  
  144. ***************************************
  145. * Deciding where LISTSERV will reside *
  146. ***************************************
  147.  
  148. Before you can  continue with the installation of LISTSERV,   you need to
  149. choose where  you want  several things to  be placed.    The installation
  150. process needs the full path names of  three directories.  All of them are
  151. defined  by  macros  in  the  Makefile  (which  was  extracted  from  the
  152. common.tar archive in the preceding step).
  153.  
  154. The  directory  where  the  mail interface  and  command  line  interface
  155. programs should be installed is defined by the BINDIR macro. The Makefile
  156. is distributed with BINDIR set to /usr/local/bin by default.  Whether you
  157. choose to use  the default directory,  or redefine  it,  the installation
  158. procedure assumes  the directory  already exists.   If  you choose  a new
  159. directory,   you  will  need  to create  it  before  running  the  final
  160. "make install". This directory is only referenced during the installation
  161. of the mail interface.  Neither the  mail interface program,  the command
  162. line interface utility,   nor the LISTSERV server  process requires write
  163. access to this directory afterwards.
  164.  
  165. Incoming mail is  written to the directory defined by  the LSVSPOOL macro
  166. in the Makefile.   The default value is /var/spool/listserv.   Unlike the
  167. BINDIR directory,   the LISTSERV spool directory  is assumed to be  a new
  168. directory.  In fact,  no other users  or daemon processes should write to
  169. this directory since LISTSERV scans this directory for incoming mail.  If
  170. the  directory  doesn't  exist  when   the   "make install"   command  is
  171. executed,  it will be created,  and the LISTSERV account will be made the
  172. owner.
  173.  
  174. The LISTSERV executable, as well as associated directories and data files
  175. will be installed in the directory pointed to by the LSVROOT macro in the
  176. Makefile. Any directory can be used, so long as LISTSERV has write access
  177. to it.  When the final "make install" is run, the LSVSPOOL directory, and
  178. several  subdirectories,  will  be created  if  necessary.  The  LISTSERV
  179. account will  be made the  owner of  those directories.  The  Makefile is
  180. distributed with the LSVROOT macro is set to /home/listserv/lsv.   If you
  181. choose  the   default  setting,    the  directories   /home/listserv/lsv,
  182. /home/listserv/lsv/home,   and /home/listserv/tmp  will be  created as  a
  183. result.
  184.  
  185. To use different  directories,  edit the Makefile and  change the BINDIR,
  186. LSVSPOOL, and/or LSVROOT macros.
  187.  
  188. Sample commands for this step:
  189.      vi Makefile
  190.  
  191. ********************************************************
  192. * Building the interface utilities and LISTSERV server *
  193. ********************************************************
  194.  
  195. The  program  that  handles  incoming mail  is  called  lsv_amin  and  is
  196. distributed in source form.  The file  lsv_amin.c is a standalone program
  197. that can be modified to suit your local mail system as needed.  It should
  198. work as distributed with unmodified Sendmail systems.  If you are running
  199. ZMAILER or PP instead of Sendmail, please contact L-Soft for installation
  200. instructions.   To compile lsv_amin, first check the CC and CFLAGS macros
  201. in the  Makefile to make certain  the compiler and options  specified are
  202. appropriate for  your system.   Second,  if you  have enabled  the syslog
  203. daemon on your system,  note that the lsv_amin program logs informational
  204. and error level messages using the syslog facility.  By default, lsv_amin
  205. logs those messages as part of the mail system. That is, LOG_MAIL is used
  206. on the  openlog()  call.  If  you would prefer  to log the  LISTSERV mail
  207. interface entries separate  from the other mail software  on your system,
  208. edit lsv_amin.c and change the line
  209.  
  210. #define LOG_FACILITY LOG_MAIL
  211.  
  212. replacing LOG_MAIL with LOG_LOCAL1,  or  whatever category is appropriate
  213. for your site.   If you are using a system on which the openlog() routine
  214. only takes two parameters,  older Ultrix system for example,  just change
  215. LOG_MAIL to 0.  Once you've checked the Makefile and (optionally) changed
  216. the  syslog  option in  lsv_amin.c,   enter  "make mailer" to  build  the
  217. program.
  218.  
  219. The "lcmd"  utility is  also distributed  in source  form.   Once  you've
  220. compiled and installed "lcmd",  users can use it to send commands to your
  221. LISTSERV server rather than having to use a mail program.  Users familiar
  222. with the Bitnet version of LISTSERV will  find "lcmd" works much like the
  223. VM "tell" and JNET "send" commands.    The primary differences being that
  224. LISTSERV sends back  mail in response to commands  submitted with "lcmd",
  225. and only your local LISTSERV can be reached.   In addition to providing a
  226. simple command line interface to  LISTSERV,  sending commands with "lcmd"
  227. obviates the need for password  validation of protected commands.   Since
  228. the origin  of the command  is determined by  the username of  the person
  229. running "lcmd",  not  by parsing mail headers,  password  checking can be
  230. skipped  by  LISTSERV.    The  lcmd.c   program  should  compile  without
  231. modification.    Site  specific  information needed  by  "lcmd"  will  be
  232. provided by  the Makefile  when building  the program.    To compile  the
  233. LISTSERV command interface enter,  "make lcmd".
  234.  
  235. The executable  for the LISTSERV  server is  shipped as one  large object
  236. file that  you need  to linkedit  on your  system to  produce a  suitable
  237. binary.  There should  be no need to  modify anything in the  Makefile to
  238. perform this step. Just enter, "make server" to build the server program.
  239. The resulting binary will be a named "lsv".
  240.  
  241. Sample commands for this step:
  242.      vi Makefile
  243.      vi lsv_amin.c
  244.      make mailer
  245.      make server
  246.      make lcmd
  247.  
  248. ***********************************************************
  249. * Moving the programs and files to the proper directories *
  250. ***********************************************************
  251.  
  252. The command, "make install" will copy the "lsv",  "lsv_amin",  and "lcmd"
  253. programs to the appropriate directories,  as  specified by the BINDIR and
  254. LSVROOT macros in the Makefile.   In addition several directories will be
  255. created and a  number of data files copied to  those directories.   While
  256. there are scenarios in which you can complete this step from the LISTSERV
  257. account,   in most  cases you  will need  to  become "root"  to run  the
  258. "make install"  command.
  259.  
  260. Sample commands for this step:
  261.      su root
  262.      make install
  263.      exit
  264.  
  265. ****************************************
  266. * Customizing LISTSERV for your system *
  267. ****************************************
  268.  
  269. LISTSERV needs to know  a variety of things about your  system,  and also
  270. how to communicate with the people that will be maintaining the software.
  271. All of the settings that you are likely  to want to change are defined in
  272. the "go.user"  shell script,  which is  created in the  LSVROOT directory
  273. when  you enter   "make install".    There are  a  number of  environment
  274. variables that  you can set  to reflect  things like the  Internet domain
  275. name of the machine that will be running LISTSERV,  the e-mail address of
  276. the LISTSERV postmaster,  etc...  You'll need to edit the go.user file in
  277. the LSVROOT  directory,  and  set each of  the variables  as appropriate.
  278. There are comments in the file explaining the purpose of each variable.
  279.  
  280. Sample commands for this step:
  281.      cd /home/listserv/lsv
  282.      vi go.user
  283.  
  284. *******************************************
  285. * Telling your mail system about LISTSERV *
  286. *******************************************
  287.  
  288. Please note that the file you need to edit in this step, and the commands
  289. you  need to  issue  will require  root  privileges.    Also,  while  the
  290. procedure for manually  modifying the sendmail aliases  file is described
  291. below, you can also enter "make aliases" to have the installation program
  292. complete this step automatically.   The  automated procedure assumes that
  293. your  sendmail  stores  aliases  in  the  file  /etc/aliases,   that  the
  294. "newaliases" command will rebuild the aliases database,  and finally that
  295. "kill -HUP `cat /etc/sendmail.pid`" will  cause Sendmail  to read  in the
  296. updated alias list.
  297.  
  298. LISTSERV accepts and  responds to several e-mail  addresses.  Even before
  299. you setup mailing lists,  mail sent to listserv and owner-listserv should
  300. be handed to LISTSERV.  The link between LISTSERV and your mail system is
  301. the lsv_amin program.  If you are running Sendmail, the best way to route
  302. incoming mail  to lsv_amin is by  adding entries to your  "aliases" file.
  303. Refer to the manual pages for sendmail on your system if you are not sure
  304. where the alias file is stored.  On  many systems the file will be called
  305. /etc/aliases. Once you have located the file, add the following lines,
  306.  
  307. listserv: "|/BBB/lsv_amin /SSS listserv"
  308. owner-listserv: "|/BBB/lsv_amin /SSS owner-listserv"
  309.  
  310. to the file, replacing /BBB with the directory where the lsv_amin program
  311. was installed (the BINDIR macro in the Makefile), and replacing /SSS with
  312. the  LISTSERV spool  directory (the  LSVSPOOL macro  from the  Makefile).
  313. Other than that,  the lines should  look exactly like the examples above.
  314. The double quotes should be entered into the alias file.
  315.  
  316. For example,  if  you changed BINDIR to /usr/lbin,  and  kept the default
  317. LSVSPOOL directory,   the new lines in  /etc/aliases would look  like the
  318. following.
  319.  
  320. listserv: "|/usr/lbin/lsv_amin /var/spool/listserv listserv"
  321. owner-listserv: "|/usr/lbin/lsv_amin /var/spool/listserv owner-listserv"
  322.  
  323. After  updating the  alias file,   you will  need to  issue two  Sendmail
  324. commands.  First  enter "newaliases" to compile  the alias file  into the
  325. format the sendmail daemon expects.  Then you need to direct the sendmail
  326. daemon currently running  on your system to read the  newly compiled list
  327. of aliases.  Refer to the manual pages  for sendmail if you are unsure of
  328. how to do so.  The command, "kill -HUP `cat /etc/sendmail.pid`" will work
  329. on AIX and SunOS systems.  If you  are running a syslog daemon,  sendmail
  330. will log the fact that it has loaded the new aliases file.  You can check
  331. the syslog output after issuing the command to make sure your changes are
  332. in place.
  333.  
  334. Sample commands for this step:
  335.      su root
  336.      cd /etc
  337.      vi aliases
  338.      newaliases
  339.      kill -HUP `cat sendmail.pid`
  340.      exit
  341.  
  342. **************************************
  343. * IMPORTANT - License Activation Key *
  344. **************************************
  345.  
  346. Please note that this step is  handled automatically for evaluation kits.
  347. The necessary file, called "license.merge", is provided in the COMMON.TAR
  348. archive  and  the "make install"  command  will  copy  it to  the  proper
  349. directory.
  350.  
  351. Before you  can start up  LISTSERV,  you will  need to install  a License
  352. Activation Key (LAK) for 'LISTSERV-xxx' (xxx = SUNOS, AIX, BSDI, etc...).
  353. In order  to offer  the same  range of  services to  all LISTSERV  sites,
  354. regardless  of the  operating system  used,  we  had to  develop our  own
  355. "license  key" scheme.   Using  system  supplied license  managers  where
  356. available and  L-Soft LAKs  elsewhere would have  required us  to develop
  357. multiple authorization  schemes,  and would  also complicate the  task of
  358. issuing license keys to customers.
  359.  
  360. Since the LAK  manager is part of  LISTSERV,  installing the LAK  is done
  361. last,  after all the  programs have been built and moved  to their proper
  362. directories.   The process is quite simple, you just create a file in the
  363. $LSVROOT/home  directory and  start the  LISTSERV server  to compile  the
  364. information.   The instructions for doing so are described in the License
  365. Registration Form that came with your installation materials.
  366.  
  367.  
  368. *************************************************************
  369. * Starting LISTSERV and Verifying a Successful Installation *
  370. *************************************************************
  371.  
  372. Once you've customized the "go.user" shell script,  you're ready to start
  373. LISTSERV.  To do so, change your current directory to LSVROOT (as defined
  374. in the  Makefile)  and  enter "go".    LISTSERV will  print some  startup
  375. messages,  then since  this is the first  time your server has  been run,
  376. LISTSERV will  generate a  number of  files needed  to route  mail.   You
  377. should see messages similar the ones below.
  378.  
  379. 12 Jun 1994 22:16:47 LISTSERV-TCP/IP for unix version 1.8a starting...
  380. 12 Jun 1994 22:16:47  Copyright L-Soft international 1986-1994
  381. 12 Jun 1994 22:16:47 SIGNUP2 file is being compressed...
  382. 12 Jun 1994 22:16:47 -> No entry removed.
  383. 12 Jun 1994 22:16:48 The network tables are outdated and must be rebuilt.
  384. * Network tables generation process started - be patient...
  385. Currently processed   500 nodes.
  386. Currently processed  1000 nodes.
  387. etc...
  388.  
  389. And once the table generation steps have finished you will see,
  390.  
  391. * Step 6 complete - link weights file successfully compiled.
  392. *
  393. * Network tables generation completed successfully.
  394. 12 Jun 1994 22:16:54 Nearest backbone host is LISTSERV@SEARN
  395. 12 Jun 1994 22:16:54 Nearest NJE host is LISTSERV@SEARN
  396. 12 Jun 1994 22:16:54 Initialization complete.
  397.  
  398. which confirms  that you've successfully  installed the  LISTSERV server.
  399. To issue  LISTSERV commands,  press  Ctrl-C and  you will be  prompted to
  400. enter  a  command.   You  can  verify  that  your customized  version  of
  401. "go.user" was  used with the RELEASE  command.   It will  display,  among
  402. other things, the address(es)  of the LISTSERV postmaster(s)  you entered
  403. in  "go.user".   If  not,  then  stop the  server and  make certain  that
  404. LISTSERV owns the "go.user" file,  and that execute permission is set for
  405. the file.  To stop LISTSERV hit Ctrl-C then enter "stop".
  406.  
  407. Once  you've  verified  that  your LISTSERV  server  starts  and  accepts
  408. commands,  you  should check to make  sure the mail interface  is working
  409. properly.   If you stopped your LISTSERV, then restart it.   You can use
  410. "go bg"  if you'd  rather have the server run in  the background.   After
  411. restarting LISTSERV,  login to a different  username and send mail to the
  412. LISTSERV account on your machine.   Include one or more LISTSERV commands
  413. in the  body of  the mail  message.   Since  you have  yet to  define any
  414. mailing lists  to your server,  commands  like RELEASE,  INFO  and THANKS
  415. would  be  good  choices.    The   mail  interface  notifies  the  server
  416. immediately upon arrival of new mail.    So unless your system is heavily
  417. used when you try sending the message,  a response should arrive within a
  418. few moments.   If  you don't receive mail back from  LISTSERV,  check for
  419. syslog entries generated by the mail interface, lsv_amin.  Also, check to
  420. see if there  are any errors on the terminal/window  where you're running
  421. LISTSERV.    If you  started the  server  with  "go bg"   check the  file
  422. "listserv.log" for error messages.
  423.  
  424. **************************************************
  425. * Talking to other LISTSERV evaluation kit users *
  426. **************************************************
  427.  
  428. A discussion  group for  sites that have  installed evaluation  copies of
  429. LISTSERV has  been created to  facilitate communication  between LISTSERV
  430. maintainers,  list owners and L-Soft support  staff.   The list is called
  431. LSTSRV-E, and you can subscribe by sending mail to LISTSERV@LISTSERV.NET,
  432. with  the command,   "SUB LSTSRV-E Your Name"  in the  body  of the  mail
  433. message.   If you have any  questions,  comments,  helpful hints,  etc...
  434. please  post   them  to  LSTSRV-E   for  distribution  to   other  people
  435. participating in the evaluation.   Don't  forget to mention which version
  436. of UNIX(R)  you are  using when posting.   The purpose of  the list is to
  437. share your experience  and problems with other users  of evaluation kits.
  438. Because there are so many versions and  brands of unix,  the kits haven't
  439. been tested equally on all possible platforms.  Knowing which kit you are
  440. using will streamline the process of finding an answer to your questions.
  441.  
  442. **************************
  443. * Registering the server *
  444. **************************
  445.  
  446. NOTE:  This section does not apply to evaluation kits.  Evaluation copies
  447. of  LISTSERV  should not  be  registered  because they  are  (presumably)
  448. temporary  servers running  test lists,   whose existence  should not  be
  449. broadcast.
  450.  
  451. Once the  server is  ready for production  use (that  is,  once  you have
  452. installed a permanent License Activation Key,  and once you have arranged
  453. for LISTSERV  to be  started automatically when  the system  boots),  you
  454. should register  it with L-Soft by  filling in the  enclosed registration
  455. form,  and returning it to  Support@LSOFT.COM.  Registering the server is
  456. necessary to broadcast its existence to the other LISTSERV servers.  Once
  457. you have registered,  your server will be sent periodic updates about the
  458. lists hosted by other LISTSERV sites, among other things, and, similarly,
  459. other LISTSERV sites will receive information  about the public lists you
  460. are hosting.  Here is the registration form  (the fields you must fill in
  461. are represented as XXXXXXXX, or a suggested value is provided):
  462.  
  463. ------------------------------- Cut here --------------------------------
  464. :node.XXXXXXXX           ! Internet hostname, including domain name.
  465. :userid.LISTSERV         ! Username under which LISTSERV runs
  466. :net.Internet            ! Must be Internet, LISTSERV for UNIX cannot
  467.                          ! cannot run in NJE (BITNET) mode
  468. :site.XXXXXXXX           ! University of XYZ, city, state, country
  469. :country.XX              ! Two-letter ISO country code
  470. :system.XXXXXXXX         ! Which type of UNIX system, and the version
  471.                          ! Examples:  SUNOS 4.1, AIX 3.2.5, etc...
  472. :machine.XXXXXXXX        ! Hardware - RS6000 320H, AXP 3000-600, etc...
  473. :contact.XXXXXXXX        ! Contact person, in the following format:
  474.                          !   (Joe Manager) JOE@XYZ.EDU (+1 301 871.2727)
  475. :type.unix               ! Do not change this - must be "unix"
  476. :version.1.8a            ! Version you are currently running
  477. :backbone.XXXXXXXX       ! YES or NO, depending on whether you want to
  478.                          ! participate in the LISTSERV backbone; L-Soft
  479.                          ! will advise you on this keyword.
  480. ------------------------------- Cut here --------------------------------
  481.  
  482. *****************
  483. * List creation *
  484. *****************
  485.  
  486. In order to create a new list, you must:
  487.  
  488. 1. Prepare a "list header", for instance using the sample provided below.
  489.    You can also get the header  of an existing (L-Soft) LISTSERV list and
  490.    use it as sample.
  491.  
  492. 2. Fill  in the  PW=CCCCCCCC on  the first line  with the  "CREATEPW" you
  493.    chose  when  configuring LISTSERV.  The  PW=XXXXXXX  line at  the  end
  494.    defines the  password you  want to  assign to your  list. This  is the
  495.    password that the list owner will have to supply with sending commands
  496.    via mail, if you select "Validate= Yes". Alternatively, you can select
  497.    "Validate=  Yes,Confirm" to  use the  "OK" mechanism,  which does  not
  498.    require any password.
  499.  
  500. 3. Mail the  resulting file  to the  LISTSERV  address,  from a  username
  501.    defined as "postmaster" in the LISTSERV configuration. For instance:
  502.  
  503.                  mail listserv@xyz.edu < newlist.create
  504.  
  505. If you have questions about  list creation, keywords, list management and
  506. other high-level or system-independent LISTSERV topics, the best place to
  507. ask them is the LSTOWN-L list, an open forum of LISTSERV list owners.
  508.  
  509. Please  note   that  LISTSERV   will  not   create  archive   directories
  510. automatically.   You must issue the appropriate "mkdir" command yourself.
  511. And when creating  such directories,  remember that  the file permissions
  512. must grant  the LISTSERV account write  access to the  directory.   Also,
  513. directories should be specified as full path names.
  514.  
  515. For  assistance  with problems  specific  to  evaluation kits,  join  the
  516. LSTSRV-E list  or contact  Support@LSOFT.COM for  a prompt  reply. Please
  517. don't forget to tell us which brand and version of unix you are running!
  518.  
  519. ************************
  520. * Note to VM customers *
  521. ************************
  522.  
  523. VM lists can be migrated to unix with a much simpler procedure:
  524.  
  525. A. Stop LISTSERV on unix, and go to its /home directory.
  526.  
  527. B. FTP a  copy of the xxxx.LIST  file from the VM system,  in ASCII mode.
  528.    Note that  you must  grab the file  as it appears  on the  VM server's
  529.    "A-disk". If you send a REVIEW command  to the VM LISTSERV, you may be
  530.    sent a  file called xxxx.LIST, but  it is not suitable  for migration:
  531.    among other  things, it will  not list subscribers with  the "conceal"
  532.    flag.
  533.  
  534. C. If the list is archived, edit the xxxx.LIST file (which is an ordinary
  535.    text file)   to insert  a suitable directory  name in  the "Notebook="
  536.    keyword (see example below).   Do not modify the lines with subscriber
  537.    names! The only lines you may edit at this stage are the ones starting
  538.    with an asterisk.
  539.  
  540. D. Start the unix LISTSERV. It  will issue a warning about incorrect list
  541.    format, and automatically convert it to the format used on unix.
  542.  
  543. You  can  also FTP  the  archive  files  (xxxx.LOGyymm) directly  to  the
  544. directory selected in point C.
  545.  
  546. ------------------------------- Cut here --------------------------------
  547. PUT SAMPLE.LIST PW=CCCCCCCC
  548. *
  549. *  Title of sample LISTSERV list
  550. *
  551. *  Review= Public    Subscription= Open         Send= Public
  552. *  Notify= Yes       Reply-to= List,Respect     Files= No
  553. *  Stats=  Normal,Private                       Validate= No
  554. *  Notebook= Yes,/some/directory,Monthly,Public
  555. *
  556. *  Owner=  someone@somewhere.EDU
  557. *
  558. * PW= XXXXXXXX
  559. ------------------------------- Cut here --------------------------------
  560.  
  561. Once  you have  constructed a  list header  file,   and sent  it to  your
  562. LISTSERV,  you need to  instruct your mail system to route  mail for that
  563. new list to the LISTSERV mail interface.  That involves adding entries to
  564. your Sendmail aliases file,  much like you did when installing the server
  565. itself.   For  each new  list,  you'll need  to add  four entries  to the
  566. aliases file.  The format of those lines is as follows,
  567.  
  568. NAME: "|/BBB/lsv_amin /SSS NAME"
  569. owner-NAME: "|/BBB/lsv_amin /SSS owner-NAME"
  570. NAME-server: "|/BBB/lsv_amin /SSS NAME-server"
  571. NAME-request: "|/BBB/lsv_amin /SSS NAME-request"
  572.  
  573. where "NAME" is  the name of the  mailing list,  "/BBB" in  the directory
  574. where the  mail interface  was installed (BINDIR  in the  Makefile),  and
  575. "/SSS" is the LISTSERV spool directory (LSVSPOOL in the Makefile).
  576.  
  577. For example,   assuming the  default values  were chosen  for BINDIR  and
  578. LSVSPOOL, the aliases for a new list called "newt" would be,
  579.  
  580. newt: "|/usr/local/bin/lsv_amin /var/spool/listserv newt"
  581. owner-newt: "|/usr/local/bin/lsv_amin /var/spool/listserv owner-newt"
  582. etc...
  583.  
  584. Once you've  added the new  aliases to the file,   you need to  issue the
  585. "newaliases" command and send your Sendmail daemon a hangup (HUP)  signal
  586. before they will take effect.
  587.  
  588. As with  the earlier step where  adding mail aliases was  necessary,  the
  589. commands  documented above  can  be automatically  invoked  by using  the
  590. "make" command.   If you system stores  aliases in /etc/aliases,  and the
  591. newaliases command can be used to compile  that file,  and if the command
  592. "kill -HUP `cat /etc/aliases`"  will cause  your Sendmail  to reload  the
  593. alias file,   then the automated  method should  work.   To add  the mail
  594. aliases for  a new list,   and to direct your  Sendmail to use  those new
  595. aliases immediatedly,  enter "make list name=XXX" where "XXX" is the name
  596. of the new list.
  597.  
  598. ***********************************
  599. * Starting LISTSERV automatically *
  600. ***********************************
  601.  
  602. The "go" shell  script can be called  from an inittab entry  if you would
  603. like LISTSERV to be started whenever your system is rebooted.   And since
  604. the "lsv" program  takes over the shell script's  process,  the "respawn"
  605. option can  be used  if you would  like the init  process to  monitor and
  606. restart LISTSERV if  it should stop for  some reason.   If you  choose to
  607. treat LISTSERV like other daemon processes,   it is advisable to redirect
  608. the standard output of the go script to a file.   Otherwise,  information
  609. needed to track and resolve problems will not be available for reference.
  610. You can  either edit the  "go" script,  which  is located in  the LSVROOT
  611. directory, or start the server with the command  "go bg".   The "bg",  or
  612. "background",  option  will redirect  LISTSERV's informational  and error
  613. messages to a  file called "listserv.log" in the  LSVROOT directory.   By
  614. way of  example,  here  is the inittab  entry used on  one of  the L-Soft
  615. development machines.
  616.  
  617. listserv:2:respawn:/u/listserv/server/go bg
  618.  
  619. Please refer to the manual pages for init, and inittab on your system for
  620. specific  information on  how such  mechanisms  work on  your version  of
  621. UNIX(R).
  622.  
  623. *************************
  624. * File server functions *
  625. *************************
  626.  
  627. There are three file server systems currently in use or under development
  628. for LISTSERV:
  629.  
  630. - The VM (mainframe) version of  LISTSERV supports the "traditional" file
  631.   server system. While it is very powerful, this file server system dates
  632.   back to 1986 and suffers from  a few annoying limitations. In addition,
  633.   it is  written in a non-portable language. This  will  be replaced with
  634.   the  "new" file  server system,  currently under  development (expected
  635.   1Q95).
  636.  
  637. - The workstation versions of LISTSERV  support a "temporary" file server
  638.   system, to  provide an interim solution  while the new system  is being
  639.   developed.  This  temporary  system  only  supports  a  subset  of  the
  640.   functions of the traditional system.
  641.  
  642. - The  "new", portable  file  server system  will be  a  superset of  the
  643.   traditional system, in  terms of functionality. Most  end user commands
  644.   will continue  to work as before.  However, there is no  guarantee that
  645.   the internal data  files manipulated by the file  server functions will
  646.   remain as before.
  647.  
  648. In general, the three systems are compatible, with the understanding that
  649. the temporary system does not include all the possible options.  However,
  650. the mechanism  for registering  files (defining them  to the  file server
  651. system)  is  different.  With the  traditional system,  you  create files
  652. called  "xxxx FILELIST",   which contain  definitions for  all the  files
  653. belonging to a particular archive.  With the temporary system,  you store
  654. these definitions in a file called "site.catalog", in the LISTSERV "root"
  655. directory.   The LSV$ROOT  macro in the Makefile  defines this directory.
  656. While you can create files called  "xxxx FILELIST" and users can retrieve
  657. them,  they  do not in  turn define further  files.  The new  file server
  658. system will eliminate this confusion,  but  in the meantime you should be
  659. aware of the differences between VM and workstation file server functions
  660. as many list owners use a VM server with different conventions.
  661.  
  662. To  register  a  new  file  to  the  server,   you  add  a  line  to  the
  663. "site.catalog" file  in the LSV$ROOT directory  (create it if it  did not
  664. exist).   Do not  modify the  "system.catalog" file,   as it  is part  of
  665. LISTSERV and  may be  replaced when you  apply service.   Here is  what a
  666. typical "site.catalog" entry looks like:
  667.  
  668. MY.FILE         my.file./aaa/bbb  XXX YYY
  669.  
  670. The  first item,  MY.FILE, is  the name  by which  the file  is known  to
  671. LISTSERV. That is, the users will use GET MY.FILE to order a copy of that
  672. file.  The  name  should  only  contain one  period.  Only  the  first  8
  673. characters of  the name and the  first 8 characters of  the extension are
  674. shown by the INDEX command. This restriction will be removed with the new
  675. file server system.
  676.  
  677. The second item,  "my.file./aaa/bbb",  is the  name LISTSERV will use for
  678. the actual UNIX file:  filename, period,  extension,  period,  directory.
  679. The  strange  format  is  because   LISTSERV  uses  an  operating  system
  680. abstraction  layer   for  file  accesses,   where   all  system-dependent
  681. attributes are relegated to the last  item.  Note that the directory must
  682. be created before you register the file.  For security reasons,  LISTSERV
  683. will not create the directory (or set the protections) for you.
  684.  
  685. The third and  fourth items are "File Access Codes"  (FACs). The first is
  686. for read accesses, and the second  for writing. The following file access
  687. codes are available:
  688.  
  689. - ALL: universal access.
  690.  
  691. - CTL: LISTSERV administrator only.
  692.  
  693. - PRIVATE(xxx): only members of the xxx list have access.
  694.  
  695. - OWNER(xxx): only the owners of the xxx list have access.
  696.  
  697. - SERVICE(xxx): only users in the service area of the xxx list have
  698.   access.
  699.  
  700. - NOTEBOOK(xxx): same access as the archives of the xxx list.
  701.  
  702. - user@host: the user in question is granted access.
  703.  
  704. Except for ALL  and CTL, which must  occur on their own,  you can specify
  705. multiple  file  access  code  entries,  separated  by  a  comma  with  no
  706. intervening space. For instance:
  707.  
  708. MY.FILE my.file./pub JOE@XYZ.EDU,JACK@XYZ.EDU,PRIVATE(XYZ-L) CTL
  709.  
  710. defines a file that  Joe, Jack and the subscribers of  the XYZ-L list can
  711. order via the  GET command, but that only the  LISTSERV administrator can
  712. update.
  713.  
  714. IMPORTANT: LISTSERV does not set file protections to ensure that only the
  715. people listed are allowed to access the files.  These attributes apply to
  716. LISTSERV commands (GET, PUT,  INDEX)  only;  it is your responsibility to
  717. protect the  actual UNIX file  and parent  directory by setting  the file
  718. protections and/or ownership (UID and GID)  to prevent unwanted access by
  719. local users.  Please keep in mind that the LISTSERV username must be able
  720. to  read the  files it  is to  distribute to  people,  and  it must  have
  721. read/write access to files  you want people to be able  to update via PUT
  722. commands.
  723.  
  724. ********************************************
  725. * The bare facts about installing LISTSERV *
  726. ********************************************
  727.  
  728. - Create a listserv account on your system.
  729.  
  730. - Make  a  temporary  directory,   say    /tmp/lsvinst   or  whatever  is
  731.   convenient.
  732.  
  733. - Copy the files,   common.tar.Z  and   `uname`.tar.Z  to that directory,
  734.   uncompress and untar them.
  735.  
  736. - Edit  Makefile   changing the BINDIR,   LSVROOT and LSVSPOOL  macros to
  737.   point to the appropriate directories.
  738.  
  739. - Enter  "make server"  to   make  the  LISTSERV  server   "lsv",   enter
  740.   "make mailer" to compile the sendmail interface, "lsv_amin",  and enter
  741.   "make lcmd" to  build the command  interface utility "lcmd".    You can
  742.   make all three of them with "make all" if you prefer.
  743.  
  744. - Edit the  file  go.user.sample   and set  the environment  variables as
  745.   directed by the comments in the file.
  746.  
  747. - Enter "make install"  to create the  LISTSERV work directory  and spool
  748.   directory,  copy  "lsv" and the data  files in the "home"  directory to
  749.   wherever  you defined  LSVROOT,  and  also  to copy  "lsv_amin" to  the
  750.   BINDIR directory.
  751.  
  752. - Add the lines,
  753.  
  754.   listserv: "|/BBB/lsv_amin /SSS listserv"
  755.   owner-listserv: "|/BBB/lsv_amin /SSS owner-listserv"
  756.  
  757.   (where  /BBB  is  the  BINDIR directory,   and  /SSS  is  the  LSVSPOOL
  758.   directory)   to your sendmail aliases  file.   Then rebuild the aliases
  759.   and send  the  appropriate signal to  your sendmail daemon to  load the
  760.   new aliases.
  761.  
  762. - Delete all the files in /tmp/lsvinst  (or whatever you called the  work
  763.   space in  step 1).    All the files  needed to  run LISTSERV  have been
  764.   copied to either LSVROOT or BINDIR already,  so there's no need to keep
  765.   anything that's left in the work directory.
  766.  
  767. - Follow the instructions  in the License Registration  Form you received
  768.   with your  installation materials  to install  your License  Access Key
  769.   (LAK).  If you are installing an evaluation copy of LISTSERV, this step
  770.   is handled automatically by the "make install" command listed above.
  771.  
  772. - To start the LISTSERV,  change directories  to LSVROOT and enter either
  773.   "go" to run the server with output logged to the terminal, or  "go bg"
  774.   to run in the background with the  log written to  listserv.log  in the
  775.   LSVROOT directory.
  776.  
  777. - Test the  server by sending mail  to "listserv" from any  account other
  778.   than  "listserv" itself  with  some command  in the  body  of the  mail
  779.   message.   Since you  haven't defined any mailing  lists yet,  commands
  780.   that don't requires lists,  like INFO,  RELEASE or even THANKS commands
  781.   might be best.
  782.  
  783. - Subscribe  to  the  LSTSRV-E  mailing   list  by  sending  the  command
  784.   "SUB LSTSRV-E Your Name",   in  the   body  of  a  mail   message,   to
  785.   LISTSERV@LISTSERV.NET.
  786.  
  787. - Once  you've tested  your  server sufficiently,   fill  out the  sample
  788.   registration  form given  in  the "Register  your  Server" section  and
  789.   return  it to  L-Soft.    Please note  that if  you  are installing  an
  790.   evaluation copy of LISTSERV you should skip this step.
  791.  
  792. If all went  well,  you're ready to  add mailing lists to  your LISTSERV.
  793. Please  refer  to   the  "List  creation"  section  of   this  guide  for
  794. instructions on how to do so.
  795.  
  796. -------------------------------------------------------------------------
  797. L-SOFT is a trademark of L-Soft international.
  798.  
  799. Unix is a registered trademark of UNIX Systems Laboratories, Inc.
  800.  
  801. AIX is a registered trademark of International Business Machines
  802. Corporation.
  803.  
  804. Ultrix is a trademark of Digital Equipment Corporation.
  805.  
  806. Sun is a registered trademark of Sun Microsystems, Inc.
  807.  
  808. JNET is a registered trademark of Wingra Technologies, Inc.
  809.  
  810. All other trademarks, both marked and not marked, are the property of
  811. their respective owners.
  812. -------------------------------------------------------------------------
  813.  
  814.