-
Notifications
You must be signed in to change notification settings - Fork 697
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6c293ca
commit 03d873a
Showing
15 changed files
with
543 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
--- | ||
sidebar_position: 5 | ||
--- | ||
|
||
# Command Line Arguments | ||
|
||
## Public | ||
|
||
Publicly available command line arguments. | ||
|
||
### `--help` | ||
|
||
Displays the help dialog. | ||
|
||
**Example:** | ||
|
||
```PowerShell | ||
NETworkManager.exe --help | ||
``` | ||
|
||
### `--reset-settings` | ||
|
||
Resets all application settings. | ||
|
||
**Example:** | ||
|
||
```PowerShell | ||
NETworkManager.exe --reset-settings | ||
``` | ||
|
||
### `--application:` | ||
|
||
Start a specific application on startup. | ||
|
||
**Possible values:** | ||
|
||
- `Dashboard` | ||
- `NetworkInterface` | ||
- `WiFi` | ||
- `IPScanner` | ||
- `PortScanner` | ||
- `PingMonitor` | ||
- `Traceroute` | ||
- `DNSLookup` | ||
- `RemoteDesktop` | ||
- `PowerShell` | ||
- `PuTTY` | ||
- `AWSSessionManager` | ||
- `TigerVNC` | ||
- `WebConsole` | ||
- `SNMP` | ||
- `SNTPLookup` | ||
- `DiscoveryProtocol` | ||
- `WakeOnLAN` | ||
- `Whois` | ||
- `SubnetCalculator` | ||
- `BitCalculator` | ||
- `Lookup` | ||
- `Connections` | ||
- `Listeners` | ||
- `ARPTable` | ||
|
||
**Example:** | ||
|
||
```PowerShell | ||
NETworkManager.exe --application:PingMonitor | ||
``` | ||
|
||
## Internal | ||
|
||
Internally used command line arguments. | ||
|
||
### `--autostart` | ||
|
||
Indicates whether the application was started automatically (via autostart). | ||
|
||
**Example:** | ||
|
||
```PowerShell | ||
NETworkManager.exe --autostart | ||
``` | ||
|
||
### `--restart-pid:` | ||
|
||
Process ID of the old application process to wait for it to end if the application is restarted. | ||
|
||
**Example:** | ||
|
||
```PowerShell | ||
NETworkManager.exe --restart-pid:35674 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
--- | ||
sidebar_position: 2 | ||
--- | ||
|
||
# Appearance | ||
|
||
### Theme | ||
|
||
Theme of the application which is based on [`MahApps.Metro themes`](https://mahapps.com/docs/themes/usage) | ||
|
||
**Type:** `String` | ||
|
||
**Default:** `Dark` | ||
|
||
**Possible values:** | ||
|
||
- `Dark` | ||
- `Light` | ||
|
||
### Accent | ||
|
||
Accent of the application which is based on [`MahApps.Metro themes`](https://mahapps.com/docs/themes/usage) | ||
|
||
**Type:** `String` | ||
|
||
**Default:** `Lime` | ||
|
||
**Possible values:** | ||
|
||
- `Red` | ||
- `Green` | ||
- `Blue` | ||
- `Purple` | ||
- `Orange` | ||
- `Lime` | ||
- `Emerald` | ||
- `Teal` | ||
- `Cyan` | ||
- `Cobalt` | ||
- `Indigo` | ||
- `Violet` | ||
- `Pink` | ||
- `Magenta` | ||
- `Crimson` | ||
- `Amber` | ||
- `Yellow` | ||
- `Brown` | ||
- `Olive` | ||
- `Steel` | ||
- `Mauve` | ||
- `Taupe` | ||
- `Sienna` | ||
|
||
:::note | ||
|
||
If you add, change or delete a theme in the folder, you must restart the application for the changes to be applied. | ||
|
||
::: | ||
|
||
### Use custom themes | ||
|
||
Enables or disables the custom themes. | ||
|
||
**Type:** `Boolean` | ||
|
||
**Default:** `Disabled` | ||
|
||
Custom themes can be placed in the `Themes` folder in the application folder (e.g. `C:\Program Files\NETworkManager\Themes`). The file name has the format `<THEME>.<ACCENT>.xaml`. For instructions on how to create custom themes, see the [MahApp.Metro documentation](https://mahapps.com/docs/themes/thememanager#creating-custom-themes). | ||
|
||
:::note | ||
|
||
Custom themes override the [`Accent`](#accent) and [`Theme`](#theme) settings. | ||
|
||
::: | ||
|
||
### Apply theme to PowerShell console | ||
|
||
Apply the current application theme to the PowerShell console global profile(s). | ||
|
||
**Type:** `Boolean` | ||
|
||
**Default:** `Disabled` | ||
|
||
If enabled, the PowerShell console global profile(s) are modified in the registry under `Computer\HKEY_CURRENT_USER\Console` (`HKCU:\Console`). This adjusts the background of the console and some other settings so that the console window integrates better with the NETworkManager application. | ||
|
||
The profiles are changed for the PowerShell consoles configured in the PowerShell and AWS Session Manager tools. Both Windows PowerShell and PowerShell 7 and later are supported. | ||
|
||
Example paths under `HKCU:\Console`: | ||
|
||
| PowerShell path | Registry profile path | | ||
| ----------------------------------------------------------- | ------------------------------------------------------------- | | ||
| `C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe` | `%SystemRoot%_System32_WindowsPowerShell_v1.0_powershell.exe` | | ||
| `C:\Program Files\PowerShell\7\pwsh.exe` | `C:_Program Files_PowerShell_7_pwsh.exe` | | ||
|
||
The following registry keys are created, modified or deleted in the registry profile path: | ||
|
||
| Name | Type | Action | Value | Value basis | | ||
| ----------- | ------------ | ------------------- | ----------------------------------- | ----------- | | ||
| `REG_DWORD` | `Add/Modify` | `CursorType` | `1` | `Hex` | | ||
| `REG_DWORD` | `Add/Modify` | `FontFamiliy` | `36` | `Hex` | | ||
| `REG_DWORD` | `Add/Modify` | `FontSize` | `120000` | `Hex` | | ||
| `REG_DWORD` | `Add/Modify` | `FontWeight` | `400` | `Hex` | | ||
| `REG_DWORD` | `Add/Modify` | `DefaultBackground` | `252525` (Dark) or `FFFFFF` (Light) | `Hex` | | ||
| `REG_DWORD` | `Add/Modify` | `ColorTable00` | `252525` (Dark) or `FFFFFF` (Light) | `Hex` | | ||
| `REG_DWORD` | `Add/Modify` | `ColorTable07` | `252525` (Dark) or `252525` (Light) | `Hex` | | ||
| `REG_SZ` | `Add/Modify` | `FaceName` | `Consolas` | `String` | | ||
| `REG_DWORD` | `Delete` | `ScreenColors` | | | | ||
|
||
If disabled, the Powershell console global profile(s) are no longer modified. But the original values are not restored. | ||
|
||
:::note | ||
|
||
Colors may not be set correctly when [`Use custom themes`](#use-custom-themes) is enabled. | ||
|
||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
sidebar_position: 7 | ||
--- | ||
|
||
# Autostart | ||
|
||
### Start with Windows (current user) | ||
|
||
Start the application automatically when the user logs in. | ||
|
||
**Type:** `Boolean` | ||
|
||
**Default:** `Disabled` | ||
|
||
### Start minimized in tray | ||
|
||
Start the application minimized in the tray when the user logs in. | ||
|
||
**Type:** `Boolean` | ||
|
||
**Default:** `Disabled` | ||
|
||
:::note | ||
|
||
Requires [Start with Windows (current user)](#start-with-windows-current-user) to be enabled. | ||
|
||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
--- | ||
sidebar_position: 0 | ||
--- | ||
|
||
# General | ||
|
||
### Show the following application on startup: | ||
|
||
Default application that is displayed when the application is launched. | ||
|
||
Type: `NETworkManager.Models.ApplicationName` | ||
|
||
Default: `Dashboard` | ||
|
||
### Visible applications | ||
|
||
Applications that are displayed in the bar. | ||
|
||
Type: `NETworkManager.Models.ApplicationName` | ||
|
||
Default: `All` | ||
|
||
### Hidden applications | ||
|
||
Applications that are not displayed in the bar. | ||
|
||
Type: `NETworkManager.Models.ApplicationName` | ||
|
||
Default: `None` | ||
|
||
### Run background job every x-minutes | ||
|
||
Run a background job every x-minutes to save profiles and settings. | ||
|
||
Type: `Integer` | ||
|
||
Default: `5` [Min `0`, Max `120`] | ||
|
||
:::note | ||
|
||
The value 0 will disable the background job. Changes to this value will take effect after restarting the application. | ||
|
||
::: | ||
|
||
### Number of stored entries | ||
|
||
Maximum number of entries stored in the history for several application inputs. | ||
|
||
Type: `Integer` | ||
|
||
Default: `5` [Min `0`, Max `25`] | ||
|
||
### ThreadPool additional min. threads | ||
|
||
Additional [minimum number of threads](https://learn.microsoft.com/en-us/dotnet/api/system.threading.threadpool.setminthreads?view=net-7.0) of the applications [ThreadPool](https://learn.microsoft.com/en-us/dotnet/standard/threading/the-managed-thread-pool) that are created on demand, as new requests are made, before switching to an algorithm for managing thread creation and destruction. This can improve e.g. the IP scanner or port scanner. The value is added to the default settings. | ||
|
||
Type: `Integer` | ||
|
||
Default: `512` [Min `0`, Max `1024`] | ||
|
||
:::note | ||
|
||
The value 0 leaves the default settings (number of CPU threads). If the value is to high, performance problems may occur. If the value is higher than the max. threads of the ThreadPool, the max. threads will be used. Changes to this value will take effect after restarting the application. Wheter the value was set successfully can be seen in the log file under `%LocalAppData%\NETworkManager\NETworkManager.log`. | ||
|
||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
sidebar_position: 6 | ||
--- | ||
|
||
# HotKeys | ||
|
||
### Untray / Bring to foreground | ||
|
||
Untray the application and bring it to the foreground. | ||
|
||
**Type:** `Boolean` | ||
|
||
**Default:** `Disabled` | ||
|
||
**Default Hotkey:** `ALT + STRG + O` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
sidebar_position: 3 | ||
--- | ||
|
||
# Language | ||
|
||
### Language | ||
|
||
Language for the user interface of the application. | ||
|
||
**Type:** `NETworkManager.Localization.LocalizationInfo` | ||
|
||
**Default:** `English` (`en-US`) | ||
|
||
:::note | ||
|
||
The language is automatically detected based on the system language. If the language is not available, the default language is used. Changes to this value will take effect after restarting the application. | ||
|
||
::: | ||
|
||
:::info | ||
|
||
English and German are provided as official languages. Other languages are provided by the community. If you want to help translate the application, you can join the project on [Transifex](https://transifex.com/BornToBeRoot/NETworkManager). Please report any issues with the translations on [GitHub](https://github.com/BornToBeRoot/NETworkManager/issues/new/choose). See also the [contribution guidelines](https://github.com/BornToBeRoot/NETworkManager/blob/main/CONTRIBUTING.md). | ||
|
||
::: |
Oops, something went wrong.