From 4fc59326991bee96fd58640a1dafb3bae4ffa7f5 Mon Sep 17 00:00:00 2001 From: =?utf8?q?=C3=81lvaro=20Fern=C3=A1ndez=20Rojas?= Date: Mon, 2 May 2016 14:46:03 +0200 Subject: [PATCH 1/1] docs: add menu for UCI config files MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Álvaro Fernández Rojas --- css/lede.css | 40 ++++++++++++++++++++++++++++++++++++++++ docs/uci_dnsmasq.txt | 6 +++++- docs/uci_dropbear.txt | 6 +++++- docs/uci_firewall.txt | 4 ++++ docs/uci_fstab.txt | 8 ++++---- docs/uci_net.txt | 8 ++++++-- docs/uci_qos.txt | 7 +++++-- docs/uci_samba.txt | 6 ++++-- docs/uci_system.txt | 6 ++++++ docs/uci_wireless.txt | 6 +++++- 10 files changed, 84 insertions(+), 13 deletions(-) diff --git a/css/lede.css b/css/lede.css index 00b3997..813b9ce 100644 --- a/css/lede.css +++ b/css/lede.css @@ -90,3 +90,43 @@ h1 { color: #fff; } +.docs_menu ol { + padding: 0; + margin: 0 -10px; + border: 2px solid #527bbd; + border-width: 2px 0; +} + +.docs_menu ol li, +.docs_menu ol li p { + padding: 0; + margin: 1px 1px 1px 1px; +} + +.docs_menu ol:after { + content: ""; + display: block; + clear: both; +} + +.docs_menu ol li { + list-style: none; + float: left; +} + +.docs_menu ol li p a:link, +.docs_menu ol li p a:visited { + color: #527bbd; + font-size: 1.1em; + text-decoration: none; + display: block; + padding: 2px 4px; + border-radius: 3px 3px 3px 3px; +} + +.docs_menu ol li p a:hover, +.docs_menu ol li p a:active, +.docs_menu ol li p a.active { + background-color: #527bbd; + color: #fff; +} diff --git a/docs/uci_dnsmasq.txt b/docs/uci_dnsmasq.txt index 0e57898..764bbbc 100644 --- a/docs/uci_dnsmasq.txt +++ b/docs/uci_dnsmasq.txt @@ -1,7 +1,11 @@ DNS and DHCP configuration ========================== -The _dnsmasq_ and dhcpd configuration is located in '/etc/config/dhcp' and controls both DNS and DHCP server options on the device. +include::uci_menu.inc[] + +== DNS and DHCP configuration + +The _dnsmasq_ and dhcpd configuration is located in **'/etc/config/dhcp'** and controls both DNS and DHCP server options on the device. In the default configuration this file contains one _common section_ to specify DNS and daemon related options and one or more _DHCP pools_ to define DHCP ranges serving on network interfaces. diff --git a/docs/uci_dropbear.txt b/docs/uci_dropbear.txt index eecfe13..1c71d46 100644 --- a/docs/uci_dropbear.txt +++ b/docs/uci_dropbear.txt @@ -1,7 +1,11 @@ Dropbear Configuration ====================== -'/etc/config/dropbear'. +include::uci_menu.inc[] + +== Dropbear Configuration + +The firewall configuration located in **'/etc/config/dropbear'**. == Sections diff --git a/docs/uci_firewall.txt b/docs/uci_firewall.txt index feaf573..5ce2dfd 100644 --- a/docs/uci_firewall.txt +++ b/docs/uci_firewall.txt @@ -1,6 +1,10 @@ Firewall configuration ====================== +include::uci_menu.inc[] + +== Firewall Configuration + The firewall configuration located in **'/etc/config/firewall'**. == Overview diff --git a/docs/uci_fstab.txt b/docs/uci_fstab.txt index b157f14..280ed24 100644 --- a/docs/uci_fstab.txt +++ b/docs/uci_fstab.txt @@ -1,11 +1,11 @@ Fstab Configuration =================== -The Fstab, or **f**ile **s**ystems **tab**le, is a central configuration that defines how file systems (usually on block devices) should be mounted if requested (such as on booting the device or connecting it physically). This way, you don't have to manually mount your devices when you want to access them. The mounting configuration can consist of static file systems but also swap partitions. The fstab UCI configuration file is where all the options for all devices and file systems to be mounted are defined and is located at... +include::uci_menu.inc[] ----- -/etc/config/fstab ----- +== Fstab Configuration + +The Fstab, or **f**ile **s**ystems **tab**le, is a central configuration that defines how file systems (usually on block devices) should be mounted if requested (such as on booting the device or connecting it physically). This way, you don't have to manually mount your devices when you want to access them. The mounting configuration can consist of static file systems but also swap partitions. The fstab UCI configuration file is where all the options for all devices and file systems to be mounted are defined and is located at **'/etc/config/fstab'**. == Initial Configuration diff --git a/docs/uci_net.txt b/docs/uci_net.txt index 4a2b32a..aa338c2 100644 --- a/docs/uci_net.txt +++ b/docs/uci_net.txt @@ -1,11 +1,15 @@ Network configuration ===================== -The central network configuration is located in the file '/etc/config/network'. This configuration file is responsible for defining _switch VLANs_, _interface configurations_ and _network routes_. +include::uci_menu.inc[] + +== Network configuration + +The central network configuration is located in the file **'/etc/config/network'**. This configuration file is responsible for defining _switch VLANs_, _interface configurations_ and _network routes_. After editing and saving '/etc/config/network' you need to execute '/etc/init.d/network reload' to stop and restart the network before any changes take effect. Rebooting the router is not necessary. -Feel free to inform yourself about link:https://www.lede-project.org/docs/procd.html[netifd] (Network Interface Daemon). +Feel free to inform yourself about link:procd.html[netifd] (Network Interface Daemon). == Sections diff --git a/docs/uci_qos.txt b/docs/uci_qos.txt index 047dcd0..78d4a68 100644 --- a/docs/uci_qos.txt +++ b/docs/uci_qos.txt @@ -1,10 +1,13 @@ Quality of Service (qos-scripts) configuration ============================================== -This is the documentation for the UCI configuration file '/etc/config/qos'. +include::uci_menu.inc[] -*WARNING*: 'luci-app-qos' won't start until you enable the 'qos' Initscript within the System-->Startup tab as well as enable qos under Network-->QoS +== Quality of Service configuration + +This is the documentation for the UCI configuration file **'/etc/config/qos'**. +*WARNING*: 'luci-app-qos' won't start until you enable the 'qos' Initscript within the System-->Startup tab as well as enable qos under Network-->QoS == Sections diff --git a/docs/uci_samba.txt b/docs/uci_samba.txt index 1ca3e9f..4cb73c8 100644 --- a/docs/uci_samba.txt +++ b/docs/uci_samba.txt @@ -1,9 +1,11 @@ Samba (smb) =========== -== UCI configuration options +include::uci_menu.inc[] -The UCI configuration file is located at /etc/config/samba. +== Samba configuration + +The Samba UCI configuration file is located at **'/etc/config/samba'**. === Common Options diff --git a/docs/uci_system.txt b/docs/uci_system.txt index fe295a4..d5ec22f 100644 --- a/docs/uci_system.txt +++ b/docs/uci_system.txt @@ -1,6 +1,12 @@ System configuration ==================== +include::uci_menu.inc[] + +== System configuration + +The system UCI configuration is located in **'/etc/config/system'**. + == Sections The 'system' configuration contains basic settings for the whole router. Larger subsystems such as the network configuration, the DHCP and DNS server, and similar, have their own configuration file. diff --git a/docs/uci_wireless.txt b/docs/uci_wireless.txt index 48fd835..36b131c 100644 --- a/docs/uci_wireless.txt +++ b/docs/uci_wireless.txt @@ -1,7 +1,11 @@ Wireless configuration ====================== -The wireless UCI configuration is located in '/etc/config/wireless'. Learn about the entire [[doc:howto:wireless.overview|IEEE 802.11 "wireless" subsystem]]. +include::uci_menu.inc[] + +== Wireless configuration + +The wireless UCI configuration is located in **'/etc/config/wireless'**. Learn about the entire [[doc:howto:wireless.overview|IEEE 802.11 "wireless" subsystem]]. By default the wireless is **OFF**. You can turn it on in the '/etc/config/wireless' by changing 'disabled 1' to 'disabled 0' -- 2.30.2