doc/readme.jupe

   1 JUPE documentation, last updated on 18 Mar 2000
   2
   3 For an ordinary user, the syntax is:
   4
   5   JUPE [<server>]
   6
   7 If <server> is given, and if a jupe for that server exists, all the
   8 information about that jupe is displayed.  If <server> is not given,
   9 all un-expired jupes are displayed.
  10
  11 For an operator, the syntax is:
  12
  13   JUPE [[+|-]<server> [[<target>] <expiration> :<reason>]]
  14
  15 If <server> is not given, or if it is not prefixed by "+" or "-", the
  16 operation is exactly the same as if it were issued by an ordinary
  17 user.  If the "+" or "-" prefixes are used, the arguments <target>,
  18 <expiration>, and <reason> must be given, even if the jupe already
  19 exists.  If <target> is "*" and the currently existing jupe is a local
  20 jupe, the local jupe will be erased and recreated with the parameters
  21 given, as described below.  Otherwise, if the jupe currently exists, a
  22 prefix of "+" will cause an inactive jupe to be activated, whereas a
  23 prefix of "-" will cause an active jupe to be deactivated.
  24
  25 If the jupe does not already exist, it is created. The <target>
  26 parameter is used to select whether the jupe is only to apply to a
  27 single server (which need not be the local server) or to the whole
  28 network; if <target> is not given, it is assumed to be the local
  29 server.  This could be useful if a single particular link is having
  30 problems, for instance.  The <expiration> parameter is a number of
  31 seconds, not to exceed 7 days, for the jupe to exist.  The <reason>
  32 argument is mandatory and should describe why this particular jupe was
  33 placed.
  34
  35 For a server, the syntax is:
  36
  37   <prefix> JU <target> (+|-)<server> <expiration> <lastmod> :<reason>
  38
  39 The <target> may be a server numeric or the character "*", for a
  40 globally scoped jupe.  The <server> argument is a server name, and
  41 must be prefixed by one of "+" (to indicate an active jupe) or "-" (to
  42 indicate an inactive jupe).  The parameter <expiration> is a total
  43 number of seconds the jupe is to live for, and <lastmod> is used for
  44 versioning.  Since JUPEs are propagated during netbursts, there must
  45 be some way of resolving conflicting states, which is the reason for
  46 this argument, and is also the reason jupes cannot be deleted, only
  47 deactivated.  The <reason> parameter indicates the reason the jupe was
  48 placed.
  49
  50 If a JUPE is received with a <target> of "*", any jupes with local
  51 scope are deleted, in preference for the globally scoped version.  If
  52 the jupe already exists, the values of <lastmod> are compared; if the
  53 received <lastmod> is less than the stored <lastmod>, the existing
  54 jupe is resent to the server from which the JUPE message was received;
  55 otherwise, the jupe is activated or deactivated, depending on the
  56 <server> prefix.  If the jupe does not currently exist, it is created
  57 with the parameters given.