[alsa-devel] alsa-utils: axfer: add manuals

GitHub pull_request - opened github at alsa-project.org
Wed Dec 5 22:46:40 CET 2018


alsa-project/alsa-utils pull request #6 was opened from takaswie:

alsa-utils: axfer: add manuals

This patchset adds manuals. As a result, users can refer to documents
by man(1):

```
 $ man 1 axfer
 $ man 1 axfer-list
 $ man 1 axfer-transfer
```

The manuals are written according to groff_man(7) and man-pages(7),
however in some points they don't follow the guideline; e.g. usage
of hyphen-minus ('-') without backslash '\' in pre-formatted text.
I'll welcome any fixes.

In this time, description of each backend in transfer subcommand is
not yet added. It will be added in later work.

```
Takashi Sakamoto (5):
  axfer: add a manual for entry point
  axfer: add a manual for list subcommand
  axfer: add a manual for transfer subcommand
  axfer: add a section to describe compatibility to aplay(1)
  axfer: add a section about design of transfer subcommand

 axfer/Makefile.am      |  10 +
 axfer/axfer-list.1     |  86 +++++++
 axfer/axfer-transfer.1 | 500 +++++++++++++++++++++++++++++++++++++++++
 axfer/axfer.1          | 132 +++++++++++
 4 files changed, 728 insertions(+)
 create mode 100644 axfer/axfer-list.1
 create mode 100644 axfer/axfer-transfer.1
 create mode 100644 axfer/axfer.1
```

Request URL   : https://github.com/alsa-project/alsa-utils/pull/6
Patch URL     : https://github.com/alsa-project/alsa-utils/pull/6.patch
Repository URL: https://github.com/alsa-project/alsa-utils


More information about the Alsa-devel mailing list