Skip to content

Commit

Permalink
Update man page for statime-linux
Browse files Browse the repository at this point in the history
  • Loading branch information
rnijveld authored and davidv1992 committed Nov 16, 2023
1 parent 7dd6591 commit ffd8667
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 10 deletions.
11 changes: 7 additions & 4 deletions docs/man/statime-linux.8.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,24 @@ title: STATIME-LINUX(8) statime 0.1.0 | statime

# NAME

`statime-linux` - ...
`statime-linux` - The Statime-linux PTP daemon

# SYNOPSIS

`statime-linux` [`-c` *path*] \
`statime-linux` `-h` \
`statime-linux` `-v`
`statime-linux` `-V`

# DESCRIPTION

...

# OPTIONS
`-c` *path*, `--config`=*path*
: Path to the configuration file for the statime-linux daemon. If not
specified this defaults to `config.toml` in the current working directory.

`-h`, `--help`
: Display usage instructions.

`-v`, `--version`
`-V`, `--version`
: Display version information.
15 changes: 12 additions & 3 deletions docs/precompiled/man/statime-linux.8
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,30 @@
.hy
.SH NAME
.PP
\f[V]statime-linux\f[R] - \&...
\f[V]statime-linux\f[R] - The Statime-linux PTP daemon
.SH SYNOPSIS
.PP
\f[V]statime-linux\f[R] [\f[V]-c\f[R] \f[I]path\f[R]]
.PD 0
.P
.PD
\f[V]statime-linux\f[R] \f[V]-h\f[R]
.PD 0
.P
.PD
\f[V]statime-linux\f[R] \f[V]-v\f[R]
\f[V]statime-linux\f[R] \f[V]-V\f[R]
.SH DESCRIPTION
.PP
\&...
.SH OPTIONS
.TP
\f[V]-c\f[R] \f[I]path\f[R], \f[V]--config\f[R]=\f[I]path\f[R]
Path to the configuration file for the statime-linux daemon.
If not specified this defaults to \f[V]config.toml\f[R] in the current
working directory.
.TP
\f[V]-h\f[R], \f[V]--help\f[R]
Display usage instructions.
.TP
\f[V]-v\f[R], \f[V]--version\f[R]
\f[V]-V\f[R], \f[V]--version\f[R]
Display version information.
5 changes: 2 additions & 3 deletions statime-linux/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,8 @@ impl clap::builder::TypedValueParser for SdoIdParser {
#[derive(Parser, Debug)]
#[clap(author, version, about, long_about = None)]
pub struct Args {
/// Time interval between Sync messages, see: 7.7.2.3
/// Default init value is 0, see: A.9.4.2
#[clap(long, short = 'c', default_value = "config.toml")]
/// Configuration file to use
#[clap(long = "config", short = 'c', default_value = "config.toml")]
config_file: Option<PathBuf>,
}

Expand Down

0 comments on commit ffd8667

Please sign in to comment.