Skip to content

Commit 5dcfacc

Browse files
committed
0.7.1b readme
1 parent 0c85f00 commit 5dcfacc

File tree

1 file changed

+29
-33
lines changed

1 file changed

+29
-33
lines changed

README.md

Lines changed: 29 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,13 @@ Internet----(eth0/wlan0)-Linux-(virtual interface)-----VM/container
6666

6767
1-file-script. Release on [Linux-router repo on Github](https://github.com/garywill/linux-router). Just download and run the bash script (meet the dependencies). In this case use without installation.
6868

69-
> I'm currently not packaging for any distro. If you do, open a PR and add the link (can be with a version badge) to list here:
69+
> I'm currently not packaging for any distro. If you do, open a PR and add the link (can be with a version badge) to list here
7070
7171
| Linux distro | |
7272
| ------------ | ---------------------------------------------------------------------------------------------------------- |
7373
| Any | download [1-file-script](https://raw.githubusercontent.com/garywill/linux-router/master/lnxrouter) and run without installation |
7474

75-
## Dependencies
75+
### Dependencies
7676

7777
- bash
7878
- procps or procps-ng
@@ -368,7 +368,7 @@ Options:
368368
Using this you can't use same wlan interface
369369
for both Internet and AP
370370
--virt-name <name> Set name of virtual interface
371-
-c <channel> Specify channel (default: use current one, or 1 / 36)
371+
-c <channel> Specify channel (default: use current, or 1 / 36)
372372
--country <code> Set two-letter country code for regularity
373373
(example: US)
374374
--freq-band <GHz> Set frequency band: 2.4 or 5 (default: 2.4)
@@ -383,31 +383,27 @@ Options:
383383
--hostapd-debug <level> 1 or 2. Passes -d or -dd to hostapd
384384
--isolate-clients Disable wifi communication between clients
385385
--no-haveged Do not run haveged automatically when needed
386-
--hs20 Enable Hotspot 2.0 (Make sure your hostapd build supports it)
386+
--hs20 Enable Hotspot 2.0
387387
388388
WiFi 4 (802.11n) configs:
389-
--ieee80211n Enable IEEE 802.11n (HT)
390-
--require-ht Require station HT (High Throughput) mode
391-
--ht-capab <HT> HT capabilities (default: [HT40+])
389+
--wifi4 Enable IEEE 802.11n (HT)
390+
--req-ht Require station HT (High Throughput) mode
391+
--ht-capab <HT caps> HT capabilities (default: [HT40+])
392392
393393
WiFi 5 (802.11ac) configs:
394-
--ieee80211ac Enable IEEE 802.11ac (VHT)
395-
--require-vht Require station VHT (Very High Thoughtput) mode
396-
--vht-capab <VHT> VHT capabilities
394+
--wifi5 Enable IEEE 802.11ac (VHT)
395+
--req-vht Require station VHT (Very High Thoughtput) mode
396+
--vht-capab <VHT caps> VHT capabilities
397397
398-
--vht-channel-width <index>
399-
Index of VHT channel width:
398+
--vht-ch-width <index> Index of VHT channel width:
400399
0 for 20MHz or 40MHz (default)
401400
1 for 80MHz
402401
2 for 160MHz
403402
3 for 80+80MHz (Non-contigous 160MHz)
404-
--vht-seg0-channel <channel>
405-
Channel index of VHT center frequency for primary
406-
segment, use with --vht-channel-width
407-
--vht-seg1-channel <channel>
408-
Channel index of VHT center frequency for secondary
409-
(second 80MHz) segment,
410-
use with '--vht-channel-width 3' .
403+
--vht-seg0-ch <channel> Channel index of VHT center frequency for primary
404+
segment. Use with '--vht-ch-width'
405+
--vht-seg1-ch <channel> Channel index of VHT center frequency for secondary
406+
(second 80MHz) segment. Use with '--vht-ch-width 3'
411407
412408
Instance managing:
413409
--daemon Run in background
@@ -429,20 +425,6 @@ Options:
429425

430426
</details>
431427

432-
## Notice
433-
434-
<details>
435-
436-
```
437-
Notice 1: This script assume your host's default policy won't forward
438-
packets, so the script won't explictly ban forwarding in any
439-
mode. In some unexpected case (eg. mistaken configurations) may
440-
cause unwanted packets leakage between 2 networks, which you
441-
should be aware of if you want isolated network
442-
```
443-
444-
</details>
445-
446428
## What changes are done to Linux system
447429

448430
On exit of a linux-router instance, script **will do cleanup**, i.e. undo most changes to system. Though, **some** changes (if needed) will **not** be undone, which are:
@@ -470,6 +452,20 @@ Visit [**my homepage** 🏡](https://garywill.github.io) to see **more tools and
470452
- 🍃 Also some [unfulfilled enhancements in the Issues](https://github.com/garywill/linux-router/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
471453
- 🙋‍♂️ Contributions are not limited to coding. There're [some posts and questions](https://github.com/garywill/linux-router/issues) that need more people to answer
472454

455+
## Notice
456+
457+
<details>
458+
459+
```
460+
Notice 1: This script assume your host's default policy won't forward
461+
packets, so the script won't explictly ban forwarding in any
462+
mode. In some unexpected case (eg. mistaken configurations) may
463+
cause unwanted packets leakage between 2 networks, which you
464+
should be aware of if you want isolated network
465+
```
466+
467+
</details>
468+
473469
## TODO
474470

475471
Sooner is better:

0 commit comments

Comments
 (0)