Browse Source

net{perf,server}: add page (#12075)

* netperf: add pages

* move pages to common; adjust syntax

* use placeholder syntax for port numbers

* Add mnemonics and manned.org link per style guide

* missing period

* Add commas
Jay Thomas 1 year ago
parent
commit
f590e064b0
2 changed files with 42 additions and 0 deletions
  1. 21 0
      pages/common/netperf.md
  2. 21 0
      pages/common/netserver.md

+ 21 - 0
pages/common/netperf.md

@@ -0,0 +1,21 @@
+# netperf
+
+> Client-side command for `netperf`, the benchmarking application that measures network throughput. Similar to `iperf`.
+> See also: `netserver`, for the server-side command.
+> More information: <https://hewlettpackard.github.io/netperf/doc/netperf.html#Global-Command_002dline-Options>.
+
+- Connect to server on a specific IP address via default port (12865):
+
+`netperf {{address}}`
+
+- Specify [p]ort:
+
+`netperf {{address}} -p {{port}}`
+
+- Specify the sampling [l]ength in seconds (default is 10):
+
+`netperf {{address}} -l {{seconds}}`
+
+- Force IPv[4] or IPv[6]:
+
+`netperf {{address}} -{{4|6}}`

+ 21 - 0
pages/common/netserver.md

@@ -0,0 +1,21 @@
+# netserver
+
+> Server-side command for `netperf`, the benchmarking application that measures network throughput.
+> See also: `netperf`, for the client-side command.
+> More information: <https://manned.org/netserver.1>.
+
+- Start a server on the default port (12865) and fork to background:
+
+`netserver`
+
+- Start server in foreground and do not fork:
+
+`netserver -D`
+
+- Specify [p]ort:
+
+`netserver -p {{port}}`
+
+- Force IPv[4] or IPv[6]:
+
+`netserver -{{4|6}}`