File: apsfilterrc.5.in

package info (click to toggle)
apsfilter 7.2.6-2
  • links: PTS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 2,496 kB
  • sloc: sh: 450; ansic: 236; perl: 175; makefile: 159
file content (209 lines) | stat: -rw-r--r-- 7,144 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
.\" Copyright (c) 2000-2002
.\"     Andreas Klemm <andreas@apsfilter.org>.  All rights reserved.
.\"
.\" $ApsCVS: src/apsfilter/man/apsfilterrc.5.in,v 1.10.2.6 2002/11/10 16:08:53 andreas Exp $
.\"                                                                           
.Dd April 08, 2000
.Dt APSFILTERRC 5
.Os
.Sh NAME
.Nm apsfilterrc
.Nd configuration file for magic print filter
.Sh SYNOPSIS
.Nm apsfillterrc
.Sh DESCRIPTION
.Nm Apsfilterrc
is a configuration file for printers controlled by the
.Xr apsfilter 1
magic filter.
.Pp
Every apsfilter printer in
.Xr printcap 5
has an
.Nm
file of its own.
.Pp
There is one global apsfilterrc file that controls print
characteristics for all printer. The printer-specific
.Nm
files have preference over the global one.
.Pp
Reasons for using an
.Nm
file are if it turns out, that you have to type in some commandline
options too often or if an application is unable to parameterize
the print command, so that you have to hardcode the print characteristic
for such dumb applications.
.Pp
An enhancement to this concept are user-specific
config files, that have preference over the global and
the printer-specific config file. This allows configuration
of print characteristics on a per-user basis.
.Pp
You should make use of user-specific config files instead
of using the deprecated USE_USER_CODE variable, which
compromises system security and is only an option on
a single-user machine, see below.
.Ss Capabilities
.Bl -tag -width THIS_MUCH_SPACE
.It Nm QUALITY
Select print quality (draft, lo|low, med|medium, hi|high, photo).
.It Nm SWEEP
Print uni- or bidirectional (uni, bi).
.It Nm MEDIA
Select paper type (plain, coated, glossy, premium, trans).
.It Nm COLOR
Select color mode (color|colour, gray|grey, mono).
.It Nm METHOD
Choose apsfilters method of data processing (auto, ascii, raw).
Automatic file type recognition and automatic conversion to Postscript
is apsfilters default processing method. If you want to print mostly
files `as is', you can set the default to 'raw', this disables any kind
of file type recognition and conversion. If you want to print mostly
everything as ASCII text, then you can set this option to 'ascii'.
.It Nm PAPERSIZE
Set the default paper size (a3, a4, legal, ledger, tabloid).
.It Nm ASCII_FILTER
Text file filter to use, when printing ASCII documents
(a2ps, mpage, enscript, recode).
.It Nm PAPERTRAY
Paper feed tray number (tray0...tray9).
.It Nm PRETTY_PRINTING
a2ps highlight level for pretty-printing when using a2ps or enscript
as ascii filter (0, 1, 2). See also ASCII_FILTER.
.It Nm ASCII_HEADER
Whether you want headers in your text prints when using a2ps, mpage
or enscript as ascii filter (header, noheader).
.It Nm ASCII_BORDER
Whether you want borders in your text prints  when using a2ps, mpage
or enscript as ascii filter (border, noborder).
.It Nm PS_NUP|ASCII_PPS
Pages per sheet (1pps, 2pps, 4pps, 8pps).
.It Nm LANDSCAPE|ASCII_LANDSCAPE
Paper orientation (landscape, portrait).
.It Nm PS_BOOK
Output pages in "book" format, implies commandline options
"2pps,duplex,shortbind". Related options: PS_NUP, ASCII_PPS,
DUPLEX, BINDING.
.It Nm DUPLEX
Whether to use duplex mode or not (duplex, simplex).
.It Nm BINDING
Paper binding edge (shortbind, longbind).
.It Nm COPIES
Number of copies (copies=N).
.It Nm USE_USER_CODE
Enabling this option is a big potential security hole !!!
If you don't understand this, DO NOT USE IT.
It makes user manageable
.Nm
files possible which will be sourced (included/executed)
during runtime of a printjob under the permissions of the
calling process (lpd).
This option is only valid for typical "single-user" systems,
where a user wants direct access to an apsfilterrc without
having to become root to make changes.
A more conveniant way on a multi-user system, where security
is an issue, is that a system administrator creates user-specific
.Nm
files. Additional informations can be found in the apsfilter
handbook and in the apsfilterrc file together with some examples.
.Sh FILES
.Bl -tag -width THIS_MUCH_SPACE -compact
.It Pa @sysconfdir@/apsfilter/apsfilterrc
apsfilter
.Em global
config file, settings are overwriteable by more specific
printer config files, see below.
.It Pa @sysconfdir@/apsfilter/QUEUE/apsfilterrc
apsfilter config file on a
.Em per printer queue
basis. This file has preference over the global config file.
.It Pa @sysconfdir@/apsfilter/QUEUE/apsfilterrc.USER
apsfilter config file on a
.Em per user
basis (per print queue). This file has preference over the global
and the printer queue specific config file.
.It Pa $HOME/.apsfilter/apsfilterrc.QUEUE
A 
.Em user defineable
config file on a per printer queue basis. This file has
preference over the global, the printer queue specific and the central
per user config file, which is administered by a system administrator.
Enabling this has a deep impact on your systems security,
.Em should NOT be used,
especially on multi-user systems and is therefore
.Em disabled by default.
See comments to USE_USER_CODE variable.
.Sh SEE ALSO
.Xr apsfilter 1 ,
.Xr printcap 5
.Sh BUGS
See apsfilter software center -
.Li http://www.apsfilter.org/
- for new versions, bugfixes and known bugs.
.Pp
Please use the new tool
.Xr apsfilter-bug 1
to release bug- or problem reports. It automatically presents you a
.Nm form
in an editor window which asks you some standard questions.
If you save and quit the editor session, then this report is
sent automatically via 
.Nm e-mail
to the proper apsfilter mailinglist.
.Pp
If apsfilter fails to print something or prints it in a way
you wouldn't expect and you want to report an apsfilter error
then please save the debugging output of one print session
using the new
.Xr aps2file 1
utility by typing
.Nm aps2file -D -Z options file > /dev/null 2> file.debug
and including the debugging output in the file
.Nm file.debug
into the edit session of the
.Nm apsfilter-bug
utility, so that it is included into the mail to the apsfilter
mailinglist.
.Pp
Please note that you need to run /bin/sh (Bourne Shell), bash
or a compatible shell, so that the above mentioned output
redirection works. Under C-shell (/bin/csh) or tcsh it would't
work. If you don't know, then simply make sure you use the
Bournce shell by typing
.Nm /bin/sh
or
.Nm bash ,
then you should have no problems with redirection of
.Nm stdout
and
.Nm stderr
(> /dev/null 2> file.debug).
.Sh DOCUMENTATION
See official apsfilter homepage
.Bl -tag -width XXXXXXXXXXXXXTHIS_MUCH_SPACEXXXXXXXXXXX -compact
.It Pa http://www.apsfilter.org/handbook.html
Apsfilter Handbook including the Frequently Asked Questions (FAQ)
.Sh USER FORUM
Please send questions to the official apsfilter help channel
.Ic apsfilter-help@apsfilter.org .
The above section
.Nm BUGS
and the file
.Ic HOWTO-BUGREPORTS
tells you how to report bugs.
If you want to know how to troubleshoot your apsfilter installation,
please read the manpage
.Xr aps2file 1
and
.Xr apsfilter-bug 1
as well as the
.Ic Apsfilter Handbook
carefully.
.Sh HISTORY
.Nm Apsfilter
developement started in 1994.
.Pp
The
.Nm
file on a "per printer queue" basis appeared in apsfilter 5.4.0.