From 242b4b9be6e22a6cdc7e2b133d0204de03d2b2eb Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Tue, 16 Jul 2019 10:09:12 -0400 Subject: [PATCH] Update the cupsd.conf man page to better explain what @IF(name) and @LOCAL do (Issue #5604) --- CHANGES.md | 1 + doc/help/man-cupsd.conf.html | 7 +++++++ man/cupsd.conf.5 | 10 +++++++++- 3 files changed, 17 insertions(+), 1 deletion(-) diff --git a/CHANGES.md b/CHANGES.md index aea1045b34..61e857f193 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -5,6 +5,7 @@ CHANGES - 2.3.0 - 2019-07-16 Changes in CUPS v2.3.0 ---------------------- +- Documentation updates (Issue #5604) - Fixed a bug in the scheduler job cleanup code (Issue #5588) - Fixed builds when there is no TLS library (Issue #5590) - Eliminated some new GCC compiler warnings (Issue #5591) diff --git a/doc/help/man-cupsd.conf.html b/doc/help/man-cupsd.conf.html index 10101dbbed..1668eee8af 100644 --- a/doc/help/man-cupsd.conf.html +++ b/doc/help/man-cupsd.conf.html @@ -457,6 +457,8 @@ The following directives may be placed inside Location and Limit sections in the
Allow @IF(name)
Allow @LOCAL
Allows access from the named hosts, domains, addresses, or interfaces. +The @IF(name) form uses the current subnets configured for the named interface. +The @LOCAL form uses the current subnets configured for all interfaces that are not point-to-point, for example Ethernet and Wi-Fi interfaces are used but DSL and VPN interfaces are not. The Order directive controls whether Allow lines are evaluated before or after Deny lines.
AuthType None
AuthType Basic @@ -476,6 +478,8 @@ The value "Default" corresponds to the DefaultAuthType value.
Deny @IF(name)
Deny @LOCAL
Denies access from the named hosts, domains, addresses, or interfaces. +The @IF(name) form uses the current subnets configured for the named interface. +The @LOCAL form uses the current subnets configured for all interfaces that are not point-to-point, for example Ethernet and Wi-Fi interfaces are used but DSL and VPN interfaces are not. The Order directive controls whether Deny lines are evaluated before or after Allow lines.
Encryption IfRequested
Encryption Never @@ -585,6 +589,9 @@ On Linux this is typically done using the command, while on macOS the launchctl(8) command is used instead. +

The @LOCAL macro name can be confusing since the system running +cupsd +often belongs to a different set of subnets from its clients.

Conforming To

The cupsd.conf file format is based on the Apache HTTP Server configuration file format.

Examples

diff --git a/man/cupsd.conf.5 b/man/cupsd.conf.5 index 75d0602790..00b1a22d66 100644 --- a/man/cupsd.conf.5 +++ b/man/cupsd.conf.5 @@ -7,7 +7,7 @@ .\" Licensed under Apache License v2.0. See the file "LICENSE" for more .\" information. .\" -.TH cupsd.conf 5 "CUPS" "2 May 2019" "Apple Inc." +.TH cupsd.conf 5 "CUPS" "16 July 2019" "Apple Inc." .SH NAME cupsd.conf \- server configuration file for cups .SH DESCRIPTION @@ -690,6 +690,8 @@ The following directives may be placed inside Location and Limit sections in the .TP 5 \fBAllow @LOCAL\fR Allows access from the named hosts, domains, addresses, or interfaces. +The @IF(name) form uses the current subnets configured for the named interface. +The @LOCAL form uses the current subnets configured for all interfaces that are not point-to-point, for example Ethernet and Wi-Fi interfaces are used but DSL and VPN interfaces are not. The Order directive controls whether Allow lines are evaluated before or after Deny lines. .TP 5 \fBAuthType None\fR @@ -724,6 +726,8 @@ The value "Default" corresponds to the DefaultAuthType value. .TP 5 \fBDeny @LOCAL\fR Denies access from the named hosts, domains, addresses, or interfaces. +The @IF(name) form uses the current subnets configured for the named interface. +The @LOCAL form uses the current subnets configured for all interfaces that are not point-to-point, for example Ethernet and Wi-Fi interfaces are used but DSL and VPN interfaces are not. The Order directive controls whether Deny lines are evaluated before or after Allow lines. .TP 5 \fBEncryption IfRequested\fR @@ -862,6 +866,10 @@ On Linux this is typically done using the command, while on macOS the .BR launchctl (8) command is used instead. +.PP +The @LOCAL macro name can be confusing since the system running +.B cupsd +often belongs to a different set of subnets from its clients. .SH CONFORMING TO The \fBcupsd.conf\fR file format is based on the Apache HTTP Server configuration file format. .SH EXAMPLES -- 2.47.2