Skip to content

Commit

Permalink
doc: update generated command docs (#4355)
Browse files Browse the repository at this point in the history 
Update generated documentation by running `make command-gendocs` in `doc/`.
  • Loading branch information
@matzf
matzf authored Jun 22, 2023
1 parent 8bace73 commit 5f7802c
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions doc/command/scion-pki/scion-pki_certificate_renew.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Options
-h, --help help for renew
-i, --interactive interactive mode
--isd-as isd-as The local ISD-AS to use. (default 0-0)
-l, --local ip Local IP address to listen on. (default zero IP)
-l, --local ip Local IP address to listen on. (default invalid IP)
--log.level string Console logging level verbosity (debug|info|error)
--no-color disable colored output
--no-probe do not probe paths for health
Expand All @@ -141,7 +141,7 @@ Options
and all specified remotes are tried in order until success or all of them failed.
--remote is mutually exclusive with --ca.
--reuse-key Reuse the provided private key instead of creating a fresh private key
--sciond string SCION Deamon address. (default "127.0.0.1:30255")
--sciond string SCION Daemon address. (default "127.0.0.1:30255")
--sequence string Space separated list of hop predicates
--subject string The path to the custom subject for the CSR
--timeout duration The timeout for the renewal request per CA (default 10s)
Expand Down
4 changes: 2 additions & 2 deletions doc/command/scion/scion_address.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ Options
-h, --help help for address
--isd-as isd-as The local ISD-AS to use. (default 0-0)
--json Write the output as machine readable json
-l, --local ip Local IP address to listen on. (default zero IP)
--sciond string SCION Deamon address. (default "127.0.0.1:30255")
-l, --local ip Local IP address to listen on. (default invalid IP)
--sciond string SCION Daemon address. (default "127.0.0.1:30255")

SEE ALSO
~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions doc/command/scion/scion_ping.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Options
-i, --interactive interactive mode
--interval duration time between packets (default 1s)
--isd-as isd-as The local ISD-AS to use. (default 0-0)
-l, --local ip Local IP address to listen on. (default zero IP)
-l, --local ip Local IP address to listen on. (default invalid IP)
--log.level string Console logging level verbosity (debug|info|error)
--max-mtu choose the payload size such that the sent SCION packet including the SCION Header,
SCMP echo header and payload are equal to the MTU of the path. This flag overrides the
Expand All @@ -108,7 +108,7 @@ Options
the total size of the packet is still variable size due to the variable size of
the SCION path.
--refresh set refresh flag for path request
--sciond string SCION Deamon address. (default "127.0.0.1:30255")
--sciond string SCION Daemon address. (default "127.0.0.1:30255")
--sequence string Space separated list of hop predicates
--timeout duration timeout per packet (default 1s)
--tracing.agent string Tracing agent address
Expand Down
8 changes: 4 additions & 4 deletions doc/command/scion/scion_showpaths.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Synopsis
'showpaths' lists available paths between the local and the specified
SCION ASe a.

By default, the paths are probed. Paths served from the SCION Deamon's might not
By default, the paths are probed. Paths served from the SCION Daemon's might not
forward traffic successfully (e.g. if a network link went down, or there is a black
hole on the path). To disable path probing, set the appropriate flag.

Expand Down Expand Up @@ -96,13 +96,13 @@ Options
--format string Specify the output format (human|json|yaml) (default "human")
-h, --help help for showpaths
--isd-as isd-as The local ISD-AS to use. (default 0-0)
-l, --local ip Local IP address to listen on. (default zero IP)
-l, --local ip Local IP address to listen on. (default invalid IP)
--log.level string Console logging level verbosity (debug|info|error)
-m, --maxpaths int Maximum number of paths that are displayed (default 10)
--no-color disable colored output
--no-probe Do not probe the paths and print the health status
-r, --refresh Set refresh flag for SCION Deamon path request
--sciond string SCION Deamon address. (default "127.0.0.1:30255")
-r, --refresh Set refresh flag for SCION Daemon path request
--sciond string SCION Daemon address. (default "127.0.0.1:30255")
--sequence string Space separated list of hop predicates
--timeout duration Timeout (default 5s)
--tracing.agent string Tracing agent address
Expand Down
4 changes: 2 additions & 2 deletions doc/command/scion/scion_traceroute.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@ Options
-h, --help help for traceroute
-i, --interactive interactive mode
--isd-as isd-as The local ISD-AS to use. (default 0-0)
-l, --local ip Local IP address to listen on. (default zero IP)
-l, --local ip Local IP address to listen on. (default invalid IP)
--log.level string Console logging level verbosity (debug|info|error)
--no-color disable colored output
--refresh set refresh flag for path request
--sciond string SCION Deamon address. (default "127.0.0.1:30255")
--sciond string SCION Daemon address. (default "127.0.0.1:30255")
--sequence string Space separated list of hop predicates
--timeout duration timeout per packet (default 1s)
--tracing.agent string Tracing agent address
Expand Down

0 comments on commit 5f7802c

Please sign in to comment.