1# cups-pdf.conf -- CUPS Backend Configuration (version 3.0.1, 2017-02-24) 2# 18.09.2005, Volker C. Behr 3# volker@cups-pdf.de 4# http://www.cups-pdf.de 5# 6# 7# This code may be freely distributed as long as this header 8# is preserved. Changes to the code should be clearly indicated. 9# 10# This code is distributed under the GPL. 11# (http://www.gnu.org/copyleft/gpl.html) 12# 13# For more detailed licensing information see cups-pdf.c in the 14# corresponding version number. 15 16########################################################################### 17# # 18# This is the configuration file for CUPS-PDF. Values that are not set in # 19# here will use the defaults. Changes take effect immediately without the # 20# need for restarting any services. # 21# # 22# Take care not to add whitespaces at the end of a line! # 23# # 24# Options are marked where they can be set (setting via PPD requires the # 25# PPD file that comes with CUPS-PDF to be used!). # 26# Options passed via lpoptions that are not named for lpoptions here are # 27# ignored. # 28# Options precedence is as follows: # 29# 1st: lpoptions # 30# 2nd: PPD settings # 31# 3rd: config file (this file) # 32# 4th: default values # 33########################################################################### 34 35 36########################################################################### 37# # 38# Path Settings # 39# # 40########################################################################### 41 42### Key: Out (config) 43## CUPS-PDF output directory 44## special qualifiers: 45## ${HOME} will be expanded to the user's home directory 46## ${USER} will be expanded to the user name 47## in case it is an NFS export make sure it is exported without 48## root_squash! 49### Default: /var/spool/cups-pdf/${USER} 50 51#Out /var/spool/cups-pdf/${USER} 52 53### Key: AnonDirName (config) 54## ABSOLUTE path for anonymously created PDF files 55## if anonymous access is disabled this setting has no effect 56### Default: /var/spool/cups-pdf/ANONYMOUS 57 58#AnonDirName /var/spool/cups-pdf/ANONYMOUS 59 60### Key: Spool (config) 61## CUPS-PDF spool directory - make sure there is no user 'SPOOL' on your 62## system or change the path 63### Default: /var/spool/cups-pdf/SPOOL 64 65Spool /var/spool/cups-pdf 66 67 68########################################################################### 69# # 70# Filename Settings # 71# # 72########################################################################### 73 74### Key: Truncate (config, ppd, lpoptions) 75## truncate long filenames to a maximum of <Truncate> characters 76## this does not consider the full path to the output but only the filename 77## without the .pdf-extension or a job-id prefix (see 'Label') 78## the minimal value is 8 79### Default: 64 80 81#Truncate 64 82 83### Key: Cut (config, lpoptions) 84## removing file name extensions before appending .pdf to output 85## extensions will only be removed if _both_ the following criteria are met: 86## - the extension (w/o the dot) is not longer than <Cut> characters 87## - the remaining filename has a minimal length of 1 character 88## set Cut to -1 in order to disable cutting 89## recommended values: pure UNIX environment : -1 90## mixed environments : 3 91### Default: 3 92 93#Cut 3 94 95### Key: Label (config, ppd, lpoptions) 96## label all jobs with a unique job-id in order to avoid overwriting old 97## files in case new ones with identical names are created; always true for 98## untitled documents 99## 0: label untitled documents only 100## 1: label all documents with a preceeding "job_#-" 101## 2: label all documents with a tailing "-job_#" 102### Default: 0 103 104#Label 0 105 106### Key: TitlePref (config, ppd, lpoptions) 107## where to look first for a title when creating the output filename 108## (title in PS file or title on commandline): 109## 0: prefer title from %Title statement in the PS file 110## 1: prefer title passed via commandline 111### Default: 0 112 113#TitlePref 0 114 115 116########################################################################### 117# # 118# User Settings # 119# # 120########################################################################### 121 122### Key: AnonUser (config) 123## uid for anonymous PDF creation (this might be a security issue) 124## this setting has no influence on AnonDirName (see there) 125## set this to an empty value to disable anonymous 126### Default: nobody 127 128#AnonUser nobody 129 130### Key: LowerCase (config) 131## This options allows to check user names given to CUPS-PDF additionally 132## against their lower case variants. This is necessary since in some 133## Windows environments only upper case user names are passed. Usually UNIX 134## user names are all lower case and it is save to use this option 135## but be aware that it can lead to mis-identifications in case 136## you have user names that differ only in upper/lower case. 137## check only against user name as passed to CUPS : 0 138## check additionally against lower case user name : 1 139### Default: 1 140 141#LowerCase 1 142 143### Key: UserPrefix (config) 144## some installations require a domain prefix added to the user name 145## leave empty for no prefix 146### Default: <empty> 147 148#UserPrefix 149 150### Key: DirPrefix (config) 151## if a prefix was defined above this switch toggels whether to include 152## the prefix in the output directory's name (if not $HOME) or not 153## 0: do not include, 1: include 154### Default: 0 155 156#DirPrefix 0 157 158### Key: RemovePrefix (config) 159## some installation pass usernames with a prefix (usually a domain name) 160## if you do not want this prefix to be used by the ${USER} variable for 161## output directories put the part which is to be cut here 162### Default: <empty> 163 164#RemovePrefix 165 166 167########################################################################### 168# # 169# Security Settings # 170# # 171########################################################################### 172 173### Key: AnonUMask (config) 174## umask for anonymous output 175## these are the _inverse_ permissions to be granted 176### Default: 0000 177 178#AnonUMask 0000 179 180### Key: UserUMask (config, lptoptions) 181## umask for user output of known users 182## changing this can introduce security leaks if confidential 183## information is processed! 184### Default: 0077 185 186#UserUMask 0077 187 188### Key: Grp (config) 189## group cups-pdf is supposed to run as - this will also be the gid for all 190## created directories and log files 191### Default: lp 192 193Grp daemon 194 195### Key: AllowUnsafeOptions (config) 196## DON'T CHANGE THIS SETTING UNLESS YOU ABSOLUTELY KNOW WHAT YOU ARE DOING 197## set to 1 in order to allow users to override any option - including 198## those that pose SEVERE SECURITY RISKS, set to 0 for full security 199### Default: 0 200 201#AllowUnsafeOptions 0 202 203 204########################################################################### 205# # 206# Log Settings # 207# # 208########################################################################### 209 210### Key: Log (config) 211## CUPS-PDF log directory 212## set this to an empty value to disable all logging 213### Default: /var/log/cups 214 215#Log /var/log/cups 216 217### Key: LogType (config, ppd) 218## log-mode 219## 1: errors 220## 2: status (i.e. activity) 221## 4: debug - this will generate a lot of log-output! 222## add up values to combine options, i.e. 7 is full logging 223## if logging is disabled these setting have no effect 224### Default: 3 225 226#LogType 3 227 228 229########################################################################### 230# # 231# PDF Conversion Settings # 232# # 233########################################################################### 234 235### Key: GhostScript (config) 236## location of GhostScript binary (gs) 237## MacOSX: for using pstopdf (recommended) set this to /usr/bin/pstopdf 238## or its proper location on your system 239### Default: /usr/bin/gs 240 241GhostScript /usr/local/bin/gs 242 243### Key: GSTmp (config) 244## location of temporary files during GhostScript operation 245## this must be user-writable like /var/tmp or /tmp ! 246### Default: /var/tmp 247 248GSTmp /tmp 249 250### Key: GSCall (config) 251## command line for calling GhostScript (!!! DO NOT USE NEWLINES !!!) 252## MacOSX: for using pstopdf set this to %s %s -o %s %s 253### Default: %s -q -dCompatibilityLevel=%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=pdfwrite -sOutputFile="%s" -dAutoRotatePages=/PageByPage -dAutoFilterColorImages=false -dColorImageFilter=/FlateEncode -dPDFSETTINGS=/prepress -c .setpdfwrite -f %s 254 255#GSCall %s -q -dCompatibilityLevel=%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=pdfwrite -sOutputFile="%s" -dAutoRotatePages=/PageByPage -dAutoFilterColorImages=false -dColorImageFilter=/FlateEncode -dPDFSETTINGS=/prepress -c .setpdfwrite -f %s 256 257### Key: PDFVer (config, ppd, lptopions) 258## PDF version to be created - can be "1.5", "1.4", "1.3" or "1.2" 259## MacOSX: for using pstopdf set this to an empty value 260### Default: 1.4 261 262#PDFVer 1.4 263 264### Key: PostProcessing (config, lptoptions) 265## postprocessing script that will be called after the creation of the PDF 266## as arguments the filename of the PDF, the username as determined by 267## CUPS-PDF and the one as given to CUPS-PDF will be passed 268## the script will be called with user privileges 269## set this to an empty value to use no postprocessing 270### Default: <empty> 271 272#PostProcessing 273 274 275########################################################################### 276# # 277# Experimental Settings # 278# These settings activate experimental options. If you decide to use # 279# them I would appreciate any feedback - including an 'ok' if they # 280# work as expected - so I can eventually put them into the non- # 281# experimental sections. # 282# # 283########################################################################### 284 285### Key: DecodeHexStrings (config) 286## this option will try to decode hex strings in the title to allow 287## internationalized titles 288## (have a look at pstitleconv on www.cups-pdf.de for a suitable filter 289## for data from Windows clients) 290## 0: disable, 1: enable 291### Default: 0 292 293#DecodeHexStrings 0 294 295### Key: FixNewlines (config) 296## this option will try to fix various unusal line delimiters (e.g. 297## form feeds) 298## especially useful when using non-Linux-generated files 299## 0: disable, 1: enable 300### Default: 0 301 302#FixNewlines 0 303