rpms/freeradius
7
0
Fork 0
Code Issues Pull Requests Releases Activity

Update clients(5) man page

Browse Source 
Remove attribute description from clients.conf(5) source as it is
outdated, lists just a few attributes and wasn't updated for more than a
year. Refer to clients.conf file itself, instead.

Remove references to non-existent naslist and clients manpages as they
are confusing.

Resolves: bug#1147464
This commit is contained in:
Nikolai Kondrashov 2014-12-08 15:41:55 +02:00
parent f683c66d9f
commit 46c7f7b947
3 changed files with 171 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
freeradius-man-remove-client-attribute-description.patch Normal file
View File

@ -0,0 +1,100 @@
From ca2eedaad0bc27dd6a540e61c583f0b745641a84 Mon Sep 17 00:00:00 2001
From: Nikolai Kondrashov <Nikolai.Kondrashov@redhat.com>
Date: Tue, 2 Dec 2014 16:39:28 +0200
Subject: [PATCH 1/2] man: Remove client attribute description
Remove attribute description from clients.conf(5) source as it is
outdated, lists just a few attributes and wasn't updated for more than a
year. Refer to clients.conf file itself, instead.
---
man/man5/clients.conf.5 | 74 +++----------------------------------------------
1 file changed, 4 insertions(+), 70 deletions(-)
diff --git a/man/man5/clients.conf.5 b/man/man5/clients.conf.5
index 9af246a..f9207d1 100644
--- a/man/man5/clients.conf.5
+++ b/man/man5/clients.conf.5
@@ -26,76 +26,10 @@ client <short-name> {
<attribute> = <value>
}
.fi
-.SH ATTRIBUTES
-The attributes that can appear in a
-.B client
-section are listed below. Required attributes are labelled as
-such. All other attributes are optional.
-.TP 0.5i
-.B ipaddr [Required]
-The IP address of the client. For IPv6, use "ipv6addr"
-.TP 0.5i
-.B secret [Required]
-The RADIUS shared secret used for communication between the client/NAS
-and the RADIUS server.
-.TP 0.5i
-.B shortname [optional]
-A short alias that can be used in place of the IP address or fully
-qualified hostname provided in the first line of the section.
-.TP 0.5i
-.B nas_type
-The nas_type attribute is used to tell the
-.BR checkrad.pl
-script which NAS-specific method it should use when checking
-simultaneous use.
-
-The following values are currently recognized:
-.nf
-cisco
-computone
-livingston
-max40xx
-multitech
-netserver
-pathras
-patton
-portslave
-tc
-usrhiper
-other
-.fi
-.TP 0.5i
-.B login
-Reserved for future use.
-.TP 0.5i
-.B password
-Reserved for future use.
-.SH EXAMPLES
-.IP
-.nf
-client localhost {
- ipaddr = 127.0.0.1
- secret = testing123
- shortname = localhost
- nas_type = other
-}
-.fi
-.LP
-This adds a client for the loopback address. This is useful in testing
-the
-server locally, for example with
-.BR radclient (1).
-.IP
-.nf
-client private-network-1 {
- ipaddr = 192.0.2.0
- netmask = 24
- secret = testing123-1
- shortname = private-network-1
-}
-.fi
-.LP
-This entry represents any client from the 192.0.2.0/24 network.
+.PP
+Clients have many configuration parameters. Most are documented in the file
+itself as comments. This page documents only the format of the file. Please
+read the \fBclients.conf\fP file itself for more information.
The old-style format from 1.x is still accepted by the server, but
that form is deprecated.
--
2.1.3

67
freeradius-man-remove-references-to-naslist-and-clients.patch Normal file
View File

@ -0,0 +1,67 @@
From 55a489a7885608158f66823686d89eb7cf54d5a9 Mon Sep 17 00:00:00 2001
From: Nikolai Kondrashov <Nikolai.Kondrashov@redhat.com>
Date: Tue, 2 Dec 2014 16:43:49 +0200
Subject: [PATCH 2/2] man: Remove references to naslist and clients
Remove references to non-existent naslist and clients manpages as they
are confusing.
---
man/man5/clients.conf.5 | 8 +++-----
man/man5/dictionary.5 | 1 -
man/man5/users.5 | 1 -
3 files changed, 3 insertions(+), 7 deletions(-)
diff --git a/man/man5/clients.conf.5 b/man/man5/clients.conf.5
index f9207d1..6c6b3ee 100644
--- a/man/man5/clients.conf.5
+++ b/man/man5/clients.conf.5
@@ -8,9 +8,9 @@ file contains definitions of RADIUS clients.
.PP
The information in this file overrides any information provided in
the deprecated
-.BR clients (5)
+.BR clients
and
-.BR naslist (5)
+.BR naslist
files.
.PP
The file format is the same as that used for
@@ -39,9 +39,7 @@ that form is deprecated.
.I /etc/raddb/radiusd.conf
.SH "SEE ALSO"
.BR radiusd (8),
-.BR radiusd.conf (5),
-.BR clients (5),
-.BR naslist (5)
+.BR radiusd.conf (5)
.SH AUTHOR
FreeRADIUS is authored by the FreeRADIUS team.
diff --git a/man/man5/dictionary.5 b/man/man5/dictionary.5
index 6b60602..d685081 100644
--- a/man/man5/dictionary.5
+++ b/man/man5/dictionary.5
@@ -176,7 +176,6 @@ the attribute number should be used instead.
.I /usr/share/freeradius/dictionary.*
.SH "SEE ALSO"
.BR radiusd (8),
-.BR naslist (5),
.BR RFC2865,
.BR RFC2866,
.BR RFC2868
diff --git a/man/man5/users.5 b/man/man5/users.5
index ed8f471..c9aef82 100644
--- a/man/man5/users.5
+++ b/man/man5/users.5
@@ -243,7 +243,6 @@ entries that set reply attributes.
.BR radclient (1),
.BR radiusd (8),
.BR dictionary (5),
-.BR naslist (5)
.SH AUTHOR
The FreeRADIUS team.
--
2.1.3

4
freeradius.spec
View File

@ -42,6 +42,8 @@ Patch18: freeradius-raddb-update-triggers-in-trigger.conf.patch
Patch19: freeradius-make-grp-tallo-c-too.patch
Patch20: freeradius-fix-checks-for-PW_TYPE_FILE_INPUT.patch
Patch21: freeradius-added-D-option-to-mirror-radclient.patch
Patch22: freeradius-man-remove-client-attribute-description.patch
Patch23: freeradius-man-remove-references-to-naslist-and-clients.patch
%global docdir %{?_pkgdocdir}%{!?_pkgdocdir:%{_docdir}/%{name}-%{version}}
@ -219,6 +221,8 @@ This plugin provides the unixODBC support for the FreeRADIUS server project.
%patch19 -p1
%patch20 -p1
%patch21 -p1
%patch22 -p1
%patch23 -p1
%build
# Force compile/link options, extra security for network facing daemon