Docs: Traceroute (#2268)

* Docs: Traceroute * Docs: Traceroute * Docs: #2268
BornToBeRoot · May 14, 2023 · 86f7e8b · 86f7e8b
1 parent 414f213
commit 86f7e8b
Show file tree

Hide file tree

Showing 5 changed files with 79 additions and 12 deletions.
diff --git a/Source/NETworkManager.Localization/Resources/Strings.Designer.cs b/Source/NETworkManager.Localization/Resources/Strings.Designer.cs
diff --git a/Source/NETworkManager.Localization/Resources/Strings.resx b/Source/NETworkManager.Localization/Resources/Strings.resx
@@ -504,8 +504,8 @@
   <data name="Maximum" xml:space="preserve">
     <value>Maximum</value>
   </data>
-  <data name="MaximumHopsRouter" xml:space="preserve">
-    <value>Maximum hops/router</value>
+  <data name="MaximumHops" xml:space="preserve">
+    <value>Maximum hops</value>
   </data>
   <data name="MinimizeInsteadOfTerminating" xml:space="preserve">
     <value>Minimize main window instead of terminating the application</value>

diff --git a/Source/NETworkManager/Views/TracerouteSettingsView.xaml b/Source/NETworkManager/Views/TracerouteSettingsView.xaml
@@ -9,11 +9,11 @@
         mc:Ignorable="d" d:DataContext="{d:DesignInstance viewModels:TracerouteSettingsViewModel}">
     <StackPanel>
         <TextBlock Text="{x:Static localization:Strings.Traceroute}" Style="{StaticResource HeaderTextBlock}" />
-        <TextBlock Text="{x:Static localization:Strings.MaximumHopsRouter}" Style="{StaticResource CenterTextBlock}"  Margin="0,0,0,10" />
-        <mah:NumericUpDown Value="{Binding MaximumHops}" Maximum="100" Minimum="1" Interval="1" Margin="0,0,0,20" />
+        <TextBlock Text="{x:Static localization:Strings.MaximumHops}" Style="{StaticResource CenterTextBlock}"  Margin="0,0,0,10" />
+        <mah:NumericUpDown Value="{Binding MaximumHops}" Minimum="1" Maximum="255" Interval="1" Margin="0,0,0,20" />
         <TextBlock Text="{x:Static localization:Strings.Ping}" Style="{StaticResource HeaderTextBlock}" />
         <TextBlock Text="{x:Static localization:Strings.TimeoutMS}" Style="{StaticResource CenterTextBlock}" Margin="0,0,0,10" />
-        <mah:NumericUpDown Value="{Binding Timeout}" Maximum="15000" Minimum="100" Interval="100" Margin="0,0,0,10" />
+        <mah:NumericUpDown Value="{Binding Timeout}" Minimum="100" Maximum="15000" Interval="100" Margin="0,0,0,10" />
         <TextBlock Text="{x:Static localization:Strings.Buffer}" Style="{StaticResource CenterTextBlock}" Margin="0,0,0,10" />
         <mah:NumericUpDown Value="{Binding Buffer}" Minimum="1" Maximum="65535" Margin="0,0,0,20" />
         <TextBlock Text="{x:Static localization:Strings.DNS}" Style="{StaticResource HeaderTextBlock}" />

diff --git a/docs/Changelog/next-release.md b/docs/Changelog/next-release.md
@@ -16,14 +16,16 @@ Release date: **xx.xx.2023**
 - [.NET Desktop Runtime 6.x (LTS)](https://dotnet.microsoft.com/download/dotnet/6.0){:target="\_blank"}
 
 ## What's new?
-  
+
 ## Improvements
+
 - TigerVNC
   - Use port from default config instead of settings if creating a new group [#2249](https://github.com/BornToBeRoot/NETworkManager/pull/2249){:target="\_blank"}
 - Wake on LAN
   - Change default port from 7 to 9 [#2242](https://github.com/BornToBeRoot/NETworkManager/pull/2242){:target="\_blank"}
 
 ## Bugfixes
+
 - Subnet Calculator
   - Fixed a design issue with the calculate button in subnetting [#2230](https://github.com/BornToBeRoot/NETworkManager/pull/2230){:target="\_blank"}
 - [AirSpace Fixer](https://www.nuget.org/packages/AirspaceFixer){:target="\_blank"} code optimized (only called if needed). This will also prevent a screenshot bug when the application is loading and a dialog is shown. [#2253](https://github.com/BornToBeRoot/NETworkManager/pull/2253){:target="\_blank"}
@@ -37,12 +39,14 @@ Deprecated
   - Wake on LAN port, because it was inconsistent (If you select the profile, the port from the settings was used. If you right-click on the profile, the port from the profile was used) [#2220](https://github.com/BornToBeRoot/NETworkManager/pull/2220){:target="\_blank"}
 
 ## Other
-- Code cleanup [#2100](https://github.com/BornToBeRoot/NETworkManager/pull/2100){:target="\_blank"} [#2172](https://github.com/BornToBeRoot/NETworkManager/pull/2172){:target="\_blank"} [#2254](https://github.com/BornToBeRoot/NETworkManager/pull/2254){:target="\_blank"} 
+
+- Code cleanup [#2100](https://github.com/BornToBeRoot/NETworkManager/pull/2100){:target="\_blank"} [#2172](https://github.com/BornToBeRoot/NETworkManager/pull/2172){:target="\_blank"} [#2254](https://github.com/BornToBeRoot/NETworkManager/pull/2254){:target="\_blank"}
 - Language files updated [#transifex](https://github.com/BornToBeRoot/NETworkManager/pulls?q=author%3Aapp%2Ftransifex-integration){:target="\_blank"}
 - Dependencies updated [#dependencies](https://github.com/BornToBeRoot/NETworkManager/pulls?q=author%3Aapp%2Fdependabot){:target="\_blank"}
 - Add documentation for:
   - Application > Port Scanner [#2265](https://github.com/BornToBeRoot/NETworkManager/pull/2265){:target="\_blank"}
   - Application > Ping Monitor [#2267](https://github.com/BornToBeRoot/NETworkManager/pull/2267){:target="\_blank"}
+  - Application > Traceroute [#2268](https://github.com/BornToBeRoot/NETworkManager/pull/2268){:target="\_blank"}
   - Application > PowerShell [#2249](https://github.com/BornToBeRoot/NETworkManager/pull/2249){:target="\_blank"}
   - Application > TigerVNC [#2248](https://github.com/BornToBeRoot/NETworkManager/pull/2248){:target="\_blank"}
   - Application > Web Console [#2244](https://github.com/BornToBeRoot/NETworkManager/pull/2244){:target="\_blank"}

diff --git a/docs/Documentation/01_Application/07_Traceroute.md b/docs/Documentation/01_Application/07_Traceroute.md
@@ -4,14 +4,77 @@ title: Traceroute
 parent: Application
 grand_parent: Documentation
 nav_order: 7
-description: ""
+description: "Documentation of Traceroute"
 permalink: /Documentation/Application/Traceroute
 ---
 
 # Traceroute
 
+With the **Traceroute** you can trace the route to a host with ICMP echo requests to determine the path to the specific host.
+
+Example inputs:
+
+- `server-01.borntoberoot.net`
+- `10.0.0.1`
+
 ![Traceroute](07_Traceroute.png)
 
 ## Profile
 
-## Settings
+### Inherit host from general
+
+Inherit the host from the general settings.
+
+**Type:** `Boolean`
+
+**Default:** `Enabled`
+
+{: .note }
+If you enable this option, the [host](#host) is overwritten by the host from the general settings and the [host](#host) is disabled.
+
+### Host
+
+Hostname or IP address to ping.
+
+**Type:** `String`
+
+**Default:** `Empty`
+
+**Example:**
+
+- `server-01.borntoberoot.net`
+- `1.1.1.1`
+
+## Settings
+
+### Maximum hops
+
+Maximum hops to search for target.
+
+**Type:** `Integer` [Min `1`, Max `255`]
+
+**Default:** `30`
+
+### Timeout (ms)
+
+Timeout in milliseconds for the icmp packet after which the packet is considered lost.
+
+**Type:** `Integer` [Min `100`, Max `15000`]
+
+**Default:** `4000`
+
+### Buffer
+
+Buffer size of the icmp packet.
+
+**Type:** `Integer` [Min `1`, Max `65535`]
+
+**Default:** `32`
+
+### Resolve hostname
+
+Resolve the hostname of the IP address (PTR lookup) for each hop.
+
+**Type:** `Boolean`
+
+**Default:** `True`