Skip to content

Commit

Permalink
Fix the man pages for the new binary name
Browse files Browse the repository at this point in the history
  • Loading branch information
rnijveld authored and davidv1992 committed Nov 22, 2023
1 parent c856131 commit e70bbc9
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 35 deletions.
27 changes: 0 additions & 27 deletions docs/man/statime-linux.8.md

This file was deleted.

27 changes: 27 additions & 0 deletions docs/man/statime.8.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!-- ---
title: STATIME(8) statime 0.1.0 | statime
--- -->

# NAME

`statime` - The Statime PTP daemon for linux

# SYNOPSIS
`statime` [`-c` *path*] \
`statime` `-h` \
`statime` `-V`

# DESCRIPTION

...

# OPTIONS
`-c` *path*, `--config`=*path*
: Path to the configuration file for the statime daemon. If not specified this
defaults to `/etc/statime/statime.toml`.

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

`-V`, `--version`
: Display version information.
Empty file removed docs/precompiled/man/ntp-ctl.8.md
Empty file.
Original file line number Diff line number Diff line change
Expand Up @@ -14,29 +14,29 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "STATIME-LINUX" "8" "" "statime 0.1.0" "statime"
.TH "STATIME" "8" "" "statime 0.1.0" "statime"
.hy
.SH NAME
.PP
\f[V]statime-linux\f[R] - The Statime-linux PTP daemon
\f[V]statime\f[R] - The Statime PTP daemon for linux
.SH SYNOPSIS
.PP
\f[V]statime-linux\f[R] [\f[V]-c\f[R] \f[I]path\f[R]]
\f[V]statime\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]
\f[V]statime\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\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.
Path to the configuration file for the statime daemon.
If not specified this defaults to \f[V]/etc/statime/statime.toml\f[R].
.TP
\f[V]-h\f[R], \f[V]--help\f[R]
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ nav:
- Guide:
- guide/setup.md
- Man Pages:
- statime-linux(8): man/statime-linux.8.md
- statime(8): man/statime.8.md
2 changes: 1 addition & 1 deletion utils/generate-man.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ set -eo pipefail

docs_dir="docs/man"
output_dir="${1:-"docs/precompiled/man"}"
files=("statime-linux.8")
files=("statime.8")

mkdir -p "$output_dir"

Expand Down

0 comments on commit e70bbc9

Please sign in to comment.