Source: lxd
Version: 5.0.2-5
Severity: normal
Tags: upstream
Problem:
Manpages of lxd-client are sometimes unintelligible. For example:
```
$ man lxc launch
LXD - Command line client(1) LXD - Command line client(1)
NAME
lxc-launch - Create and start instances from images
SYNOPSIS
lxc launch [:] [:][] [flags]
...
Auto generated by spf13/cobra May 2023 LXD - Command line client(1)
```
Please compare odd SYNOPSIS in the above manpage with `-h` option result
of the command as below..
```
$ lxc launch -h
Description:
Create and start instances from images
Usage:
lxc launch [<remote>:]<image> [<remote>:][<name>] [flags]
...
```
Proposed interim fix:
Add README.Debian for affected binary packages mentioning manpaage
problem and guide people to use `-h` option with command to get
intelligible help.
Speculated root cause and fix path:
As noted at the bottom of manpage, this is generated from help message
of the corresponding command. I don't know how exacly it process help
message but it processing seems to drop words between "<" and ">".
If plain text markup is converted to XML and then passed to xml2man or
xmlto type processor, this kind of problem may happen unless "<" and ">"
are escaped properly before their processing.
I understand this is upstream problem but I don't know where to send
this bug report due to lxd and incus situation. This is probably needs
fix to the manpage generation script or rewrite all manpage without
problematic "<" and ">".
Osamu
-- System Information:
Debian Release: 12.2
APT prefers stable-updates
APT policy: (500, 'stable-updates'), (500, 'stable-security'), (500, 'stable')
Architecture: amd64 (x86_64)
Kernel: Linux 6.4.0-0.deb12.2-amd64 (SMP w/12 CPU threads; PREEMPT)
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8),
LANGUAGE=en_US:en
Shell: /bin/sh linked to /usr/bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled
