diff options
Diffstat (limited to 'nixos/modules/services/networking/hostapd.nix')
-rw-r--r-- | nixos/modules/services/networking/hostapd.nix | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/nixos/modules/services/networking/hostapd.nix b/nixos/modules/services/networking/hostapd.nix index f719ff59cc7..ec1a7a58b1e 100644 --- a/nixos/modules/services/networking/hostapd.nix +++ b/nixos/modules/services/networking/hostapd.nix @@ -53,13 +53,13 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable putting a wireless interface into infrastructure mode, allowing other wireless devices to associate with the wireless interface and do wireless networking. A simple access point will - <option>enable hostapd.wpa</option>, - <option>hostapd.wpaPassphrase</option>, and - <option>hostapd.ssid</option>, as well as DHCP on the wireless + {option}`enable hostapd.wpa`, + {option}`hostapd.wpaPassphrase`, and + {option}`hostapd.ssid`, as well as DHCP on the wireless interface to provide IP addresses to the associated stations, and NAT (from the wireless interface to an upstream interface). ''; @@ -69,15 +69,15 @@ in default = ""; example = "wlp2s0"; type = types.str; - description = '' - The interfaces <command>hostapd</command> will use. + description = lib.mdDoc '' + The interfaces {command}`hostapd` will use. ''; }; noScan = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Do not scan for overlapping BSSs in HT40+/- mode. Caution: turning this on will violate regulatory requirements! ''; @@ -87,8 +87,8 @@ in default = "nl80211"; example = "hostapd"; type = types.str; - description = '' - Which driver <command>hostapd</command> will use. + description = lib.mdDoc '' + Which driver {command}`hostapd` will use. Most applications will probably use the default. ''; }; @@ -97,13 +97,13 @@ in default = "nixos"; example = "mySpecialSSID"; type = types.str; - description = "SSID to be used in IEEE 802.11 management frames."; + description = lib.mdDoc "SSID to be used in IEEE 802.11 management frames."; }; hwMode = mkOption { default = "g"; type = types.enum [ "a" "b" "g" ]; - description = '' + description = lib.mdDoc '' Operation mode. (a = IEEE 802.11a, b = IEEE 802.11b, g = IEEE 802.11g). ''; @@ -113,11 +113,11 @@ in default = 7; example = 11; type = types.int; - description = '' + description = lib.mdDoc '' Channel number (IEEE 802.11) Please note that some drivers do not use this value from - <command>hostapd</command> and the channel will need to be configured - separately with <command>iwconfig</command>. + {command}`hostapd` and the channel will need to be configured + separately with {command}`iwconfig`. ''; }; @@ -125,15 +125,15 @@ in default = "wheel"; example = "network"; type = types.str; - description = '' - Members of this group can control <command>hostapd</command>. + description = lib.mdDoc '' + Members of this group can control {command}`hostapd`. ''; }; wpa = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Enable WPA (IEEE 802.11i/D3.0) to authenticate with the access point. ''; }; @@ -142,7 +142,7 @@ in default = "my_sekret"; example = "any_64_char_string"; type = types.str; - description = '' + description = lib.mdDoc '' WPA-PSK (pre-shared-key) passphrase. Clients will need this passphrase to associate with this access point. Warning: This passphrase will get put into a world-readable file in @@ -153,7 +153,7 @@ in logLevel = mkOption { default = 2; type = types.int; - description = '' + description = lib.mdDoc '' Levels (minimum value for logged events): 0 = verbose debugging 1 = debugging @@ -167,7 +167,7 @@ in default = null; example = "US"; type = with types; nullOr str; - description = '' + description = lib.mdDoc '' Country code (ISO/IEC 3166-1). Used to set regulatory domain. Set as needed to indicate country in which device is operating. This can limit available channels and transmit power. @@ -187,7 +187,7 @@ in ht_capab=[HT40-][SHORT-GI-40][DSSS_CCK-40] ''; type = types.lines; - description = "Extra configuration options to put in hostapd.conf."; + description = lib.mdDoc "Extra configuration options to put in hostapd.conf."; }; }; }; |