fix several references to samba-bugs@anu.edu.au which should be samba-bugs@samba...
[jra/samba/.git] / docs / manpages / testprns.1
1 .TH TESTPRNS 1 testprns testprns
2 .SH NAME
3 testprns \- check printer name for validity with smbd
4 .SH SYNOPSIS
5 .B testprns
6 .I printername
7 [
8 .I printcapname
9 ]
10 .SH DESCRIPTION
11 This program is part of the Samba suite.
12
13 .B testprns
14 is a very simple test program to determine whether a given 
15 printer name is valid for use in a service to be provided by
16 .B smbd.
17
18 "Valid" in this context means "can be found in the printcap specified". This
19 program is very stupid - so stupid in fact that it would be wisest to always
20 specify the printcap file to use.
21 .SH OPTIONS
22 .I printername
23
24 .RS 3
25 The printer name to validate.
26
27 Printer names are taken from the first field in each record in the printcap
28 file, single printer names and sets of aliases separated by vertical bars
29 ("|") are recognised. Note that no validation or checking of the printcap
30 syntax is done beyond that required to extract the printer name. It may
31 be that the print spooling system is more forgiving or less forgiving
32 than 
33 .BR testprns .
34 However, if
35 .B testprns
36 finds the printer then
37 .B smbd
38 should do so as well.
39 .RE
40
41 .I printcapname
42
43 .RS 3
44 This is the name of the printcap file to search for the given printer name
45 in.
46
47 If no printcap name is specified,
48 .B testprns
49 will attempt to scan the printcap file specified at compile time 
50 (PRINTCAP_NAME).
51 .RE
52 .SH FILES
53 .B /etc/printcap
54 .RS 3
55 This is usually the default printcap file to scan. See
56 .BR printcap (5)).
57 .RE
58 .SH ENVIRONMENT VARIABLES
59 Not applicable.
60 .SH INSTALLATION
61 The location of the server and its support files is a matter for individual
62 system administrators. The following are thus suggestions only.
63
64 It is recommended that the
65 .B testprns
66 program be installed under the /usr/local/samba hierarchy, in a directory readable
67 by all, writeable only by root. The program should be executable by all.
68 The program should NOT be setuid or setgid!
69 .SH VERSION
70 This man page is (mostly) correct for version 1.9.00 of the Samba suite, plus some
71 of the recent patches to it. These notes will necessarily lag behind 
72 development of the software, so it is possible that your version of 
73 the program has extensions or parameter semantics that differ from or are not 
74 covered by this man page. Please notify these to the address below for 
75 rectification.
76 .SH SEE ALSO
77 .BR printcap (5),
78 .BR smbd (8), 
79 .BR smbclient (1)
80 .SH DIAGNOSTICS
81 If a printer is found to be valid, the message "Printer name <printername> is 
82 valid" will be displayed.
83
84 If a printer is found to be invalid, the message "Printer name <printername> 
85 is not valid" will be displayed.
86
87 All messages that would normally be logged during operation of
88 .B smbd
89 are
90 logged by this program to the file
91 .I test.log
92 in the current directory. The program runs at debuglevel 3, so quite extensive
93 logging information is written. The log should be checked carefully for errors
94 and warnings.
95
96 Other messages are self-explanatory.
97 .SH BUGS
98 None known.
99 .SH CREDITS
100 The original Samba software and related utilities were created by 
101 Andrew Tridgell (samba-bugs@samba.anu.edu.au). Andrew is also the Keeper
102 of the Source for this project.
103
104 The
105 .B testprns
106 program and this man page were written by Karl Auer. Bug reports to 
107 samba-bugs@samba.anu.edu.au.
108
109 See
110 .BR samba (7)
111 for a full list of contributors and details of how to 
112 submit bug reports, comments etc.