man/subscriptions.conf.man

   1 .\"
   2 .\" "$Id: subscriptions.conf.man 177 2006-06-21 00:20:03Z jlovell $"
   3 .\"
   4 .\"   subscriptions.conf man page for the Common UNIX Printing System (CUPS).
   5 .\"
   6 .\"   Copyright 2006 by Easy Software Products.
   7 .\"
   8 .\"   These coded instructions, statements, and computer programs are the
   9 .\"   property of Easy Software Products and are protected by Federal
  10 .\"   copyright law.  Distribution and use rights are outlined in the file
  11 .\"   "LICENSE.txt" which should have been included with this file.  If this
  12 .\"   file is missing or damaged please contact Easy Software Products
  13 .\"   at:
  14 .\"
  15 .\"       Attn: CUPS Licensing Information
  16 .\"       Easy Software Products
  17 .\"       44141 Airport View Drive, Suite 204
  18 .\"       Hollywood, Maryland 20636 USA
  19 .\"
  20 .\"       Voice: (301) 373-9600
  21 .\"       EMail: cups-info@cups.org
  22 .\"         WWW: http://www.cups.org
  23 .\"
  24 .TH subscriptions.conf 5 "Common UNIX Printing System" "30 April 2006" "Easy Software Products"
  25 .SH NAME
  26 subscriptions.conf \- subscriptions file for cups
  27 .SH DESCRIPTION
  28 The \fIsubscriptions.conf\fR file defines the local subscriptions
  29 that are active. It is normally located in the \fI/etc/cups\fR
  30 directory and is generated automatically by the \fIcupsd(8)\fR
  31 program when subscriptions are created, renewed, or cancelled.
  32 .LP
  33 Each line in the file can be a configuration directive, a blank line,
  34 or a comment. Comment lines start with the # character.
  35 .SH DIRECTIVES
  36 .TP 5
  37 <Subscription NNN> ... </Subscription>
  38 .br
  39 Defines a subscription.
  40 .TP 5
  41 Events name [ ... name ]
  42 .br
  43 Specifies the events that are subscribed.
  44 .TP 5
  45 ExpirationTime unix-time
  46 .br
  47 Specifies the expiration time of a subscription as a UNIX time
  48 value in seconds since January 1st, 1970.
  49 .TP 5
  50 Interval seconds
  51 .br
  52 Specifies the preferred time interval for event notifications in
  53 seconds.
  54 .TP 5
  55 JobId job-id
  56 .br
  57 Specifies the job ID associated with the subscription.
  58 .TP 5
  59 LeaseDuration seconds
  60 .br
  61 Specifies the number of seconds that the subscription is valid
  62 for. If 0, the subscription does not expire.
  63 .TP 5
  64 NextEventId number
  65 .br
  66 Specifies the next notify-sequence-number to use for the
  67 subscription.
  68 .TP 5
  69 NextSubscriptionId number
  70 .br
  71 Specifies the next subscription-id to use.
  72 .TP 5
  73 Owner username
  74 .br
  75 Specifies the user that owns the subscription.
  76 .TP 5
  77 PrinterName printername
  78 .br
  79 Specifies the printer or class associated with the subscription.
  80 .TP 5
  81 Recipient uri
  82 .br
  83 Specifies the notify-recipient-uri value for push-type notifications.
  84 .TP 5
  85 UserData hex-escaped-data
  86 .br
  87 Specifies user data to be included in event notifications. This
  88 is typically the "from" address in mailto: notifications.
  89 .SH SEE ALSO
  90 \fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR,
  91 \fImime.convs(5)\fR, \fImime.types(5)\fR, \fRprinters.conf(5)\fR
  92 .br
  93 http://localhost:631/help
  94 .SH COPYRIGHT
  95 Copyright 1997-2006 by Easy Software Products, All Rights Reserved.
  96 .\"
  97 .\" End of "$Id: subscriptions.conf.man 177 2006-06-21 00:20:03Z jlovell $".
  98 .\"