Skip to content

documentation/manpages/man.1 (Invalid format) #224

@krekhovx

Description

@krekhovx

Hi, I from Debian community. I'm trying to package your software into a Debian package. Lintian utility says:

W: clipboard: bad-whatis-entry [usr/share/man/man1/cb.1.gz]
N: 
N:   A manual page should start with a NAME section, which lists the program
N:   name and a brief description. The NAME section is used to generate a
N:   database that can be queried by commands like apropos and whatis. You are
N:   seeing this tag because lexgrog was unable to parse the NAME section.
N:   
N:   Manual pages for multiple programs, functions, or files should list each
N:   separated by a comma and a space, followed by \- and a common description.
N:   
N:   Listed items may not contain any spaces. A manual page for a two-level
N:   command such as fs listacl must look like fs_listacl so the list is read
N:   correctly.
N: 
N:   Please refer to the lexgrog(1) manual page, the groff_man(7) manual page,
N:   and the groff_mdoc(7) manual page for details.
N: 
N:   Visibility: warning
N:   Show-Always: no
N:   Check: documentation/manual
N:   Renamed from: manpage-has-bad-whatis-entry

I agree with this. It would be better to change the format of the manual a little.
Please look at the fix-bad-whatis-entry.patch:

Forwarded: yes
Last-Update: 2025-02-20
Author: Kirill Rekhov <krekhov.dev@gmail.com>
Description: Fix Lintian warning for manual
Bug-Clipboard: https://github.com/Slackadays/Clipboard/issues/224

--- clipboard-0.10.0.orig/documentation/manpages/man.1
+++ clipboard-0.10.0/documentation/manpages/man.1
@@ -1,8 +1,9 @@
 .\" Automatically generated by Pandoc 2.9.2.1
 .\"
-.TH "" "" "" "" ""
+.TH "cb" "1" "" "" ""
 .hy
-.SH cb(1) \[en] cut, copy, and paste anything in the terminal
+.SH NAME
+cb \- cut, copy, and paste anything in the terminal
 .SS SYNOPSIS
 .PP
 \f[B]cb\f[R] [--](add|copy|cut)[(num)|_(id)] (file) files

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions