From: Hugo Villeneuve Date: Tue, 7 Apr 2026 16:34:16 +0000 (-0400) Subject: Update man page with help2man X-Git-Url: http://gitweb.hugovil.com/r193.html?a=commitdiff_plain;h=HEAD;p=hvrtc.git Update man page with help2man Signed-off-by: Hugo Villeneuve --- diff --git a/doc/hvrtc.man b/doc/hvrtc.man index bfa3e92..38b50d8 100644 --- a/doc/hvrtc.man +++ b/doc/hvrtc.man @@ -1,30 +1,61 @@ -.TH HVRTC 1 "December 2020" "hvrtc" "User's Manual" - +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. +.TH HVRTC "1" "April 2026" "hvrtc 2.0.0" "User Commands" .SH NAME -hvrtc \- tool to configure/query RTC devices. - +hvrtc \- manual page for hvrtc 2.0.0 .SH SYNOPSIS .B hvrtc -[\fIOPTION\fR]... [\fIFILENAME\fR] - +[\fI\,OPTION\/\fR...] .SH DESCRIPTION -\fBhvrtc\fR is a ... [TODO]. - -.SH "OPTIONS" - -.TP -\fB\-h\fR -display usage and exit -.TP -\fB\-version\fR -output version information and exit - -.SH CREDITS -\fBhvrtc\fR was originally written by Hugo Villeneuve , based on +hvrtc \fB\-\-\fR RTC configuration/query tool +.TP +\fB\-b\fR, \fB\-\-bsm\fR[=\fI\,value\/\fR] +Get/Set Backup Switch Mode (BSM): +.IP +disabled RTC_BSM_DISABLED +direct RTC_BSM_DIRECT +level RTC_BSM_LEVEL +standby RTC_BSM_STANDBY +.TP +\fB\-c\fR, \fB\-\-clear\fR +Clear "voltage low" event +.TP +\fB\-d\fR, \fB\-\-dev\fR=\fI\,path\/\fR +RTC device path (optional) +.TP +\fB\-t\fR, \fB\-\-time\fR +Get RTC time +.TP +\fB\-v\fR, \fB\-\-voltage\-level\fR +Get battery backup voltage level +.TP +\fB\-x\fR, \fB\-\-test\fR +Test RTC +.TP +\-?, \fB\-\-help\fR +Give this help list +.TP +\fB\-\-usage\fR +Give a short usage message +.TP +\fB\-V\fR, \fB\-\-version\fR +Print program version +.PP +Mandatory or optional arguments to long options are also mandatory or optional +for any corresponding short options. +.SH AUTHOR +Written by Hugo Villeneuve , based on "Real Time Clock Driver Test/Example Program" by Paul Gortmaker. - -.SH COPYRIGHT -\fBhvrtc\fR is free; anyone may redistribute it to anyone under the terms -stated in the GNU General Public License. A copy of the license is included in -the \fBhvrtc\fR distribution. You can also browse it online at -.I http://www.gnu.org/copyleft/gpl.html +.SH "REPORTING BUGS" +Report bugs to hugo@hugovil.com. +.SH "SEE ALSO" +The full documentation for +.B hvrtc +is maintained as a Texinfo manual. If the +.B info +and +.B hvrtc +programs are properly installed at your site, the command +.IP +.B info hvrtc +.PP +should give you access to the complete manual.