diff options
author | Seth Forshee <seth.forshee@canonical.com> | 2017-12-21 17:15:27 -0600 |
---|---|---|
committer | Seth Forshee <seth.forshee@canonical.com> | 2017-12-23 21:20:07 -0600 |
commit | 2f939506ea27ba2661ea8d8ce0cd2516188fb6e9 (patch) | |
tree | a17deb0eeaf772e736023e3ecbdae99588b438ba | |
parent | ec894ad97b32b387a4d4d59dc187f8e200bb5b73 (diff) | |
download | wireless-regdb-2f939506ea27ba2661ea8d8ce0cd2516188fb6e9.tar.gz |
wireless-regdb: Document regulatory.db in the manual page
Add information about regulatory.db to the regulatory.bin man
page, and alias the regulatory.db man page to refer to the page
for regulatory.bin.
Signed-off-by: Seth Forshee <seth.forshee@canonical.com>
-rw-r--r-- | Makefile | 2 | ||||
-rw-r--r-- | regulatory.bin.5 | 32 | ||||
-rw-r--r-- | regulatory.db.5 | 1 |
3 files changed, 24 insertions, 11 deletions
@@ -126,4 +126,4 @@ install: regulatory.bin.5.gz regulatory.db.5.gz install -m 644 -t $(DESTDIR)/$(CRDA_PATH)/ regulatory.bin install -m 644 -t $(DESTDIR)/$(FIRMWARE_PATH) regulatory.db regulatory.db.p7s install -m 755 -d $(DESTDIR)/$(MANDIR)/man5/ - install -m 644 -t $(DESTDIR)/$(MANDIR)/man5/ regulatory.bin.5.gz + install -m 644 -t $(DESTDIR)/$(MANDIR)/man5/ regulatory.bin.5.gz regulatory.db.5.gz diff --git a/regulatory.bin.5 b/regulatory.bin.5 index 430c65c..b1862cd 100644 --- a/regulatory.bin.5 +++ b/regulatory.bin.5 @@ -1,6 +1,6 @@ -.TH regulatory.bin 5 "23 January 2009" "regulatory.bin" "Linux" +.TH regulatory.bin 5 "21 December 2017" "regulatory.bin" "Linux" .SH NAME -regulatory.bin \- The Linux wireless regulatory database +regulatory.bin, regulatory.db \- The Linux wireless regulatory database .ad l .in +8 @@ -9,24 +9,36 @@ regulatory.bin \- The Linux wireless regulatory database .SS .SH Description .B regulatory.bin -is the file used by the Linux wireless subsystem to keep its regulatory -database information. It is read by +and +.B regulatory.db +are the files used by the Linux wireless subsystem to keep its regulatory +database information. +.PP +.B regulatory.bin +is read by .B crda upon the Linux kernel's request for regulatory information for a specific -ISO / IEC 3166 alpha2 country code. The regulatory database is kept in -a small binary format for size and code efficiency. The +ISO / IEC 3166 alpha2 country code. +.PP +.B regulatory.db +is a newer, extensible database format which (since Linux 4.15) is read +by the kernel directly as a firmware file. + +The regulatory database is kept in a small binary format for size and code +efficiency. The .B regulatory.bin file can be parsed and read in human format by using the .B regdbdump -command. The -.B regulatory.bin -file should be updated upon regulatory changes or corrections. +command. The regulatory database files should be updated upon regulatory +changes or corrections. .SH Upkeeping The regulatory database is maintained by the community as such you are encouraged to send any corrections or updates to the -linux-wireless mailing list: +linux-wireless and wireless-regdb mailing lists: .B linux-wireless@vger.kernel.org +and +.B wireless-regdb@lists.infradead.org .SH SEE ALSO .BR regdbdump (8) diff --git a/regulatory.db.5 b/regulatory.db.5 new file mode 100644 index 0000000..6c8aae3 --- /dev/null +++ b/regulatory.db.5 @@ -0,0 +1 @@ +.so man5/regulatory.bin.5.gz |