2
0

manpage.md.ex 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134
  1. % kbdled(SECTION) | User Commands
  2. %
  3. % "February 24 2026"
  4. [comment]: # The lines above form a Pandoc metadata block. They must be
  5. [comment]: # the first ones in the file.
  6. [comment]: # See https://pandoc.org/MANUAL.html#metadata-blocks for details.
  7. [comment]: # pandoc -s -f markdown -t man package.md -o package.1
  8. [comment]: #
  9. [comment]: # A manual page package.1 will be generated. You may view the
  10. [comment]: # manual page with: nroff -man package.1 | less. A typical entry
  11. [comment]: # in a Makefile or Makefile.am is:
  12. [comment]: #
  13. [comment]: # package.1: package.md
  14. [comment]: # pandoc --standalone --from=markdown --to=man $< --output=$@
  15. [comment]: #
  16. [comment]: # The pandoc binary is found in the pandoc package. Please remember
  17. [comment]: # that if you create the nroff version in one of the debian/rules
  18. [comment]: # file targets, such as build, you will need to include pandoc in
  19. [comment]: # your Build-Depends control field.
  20. [comment]: # lowdown is a low dependency, lightweight alternative to
  21. [comment]: # pandoc as a markdown to manpage translator. Use with:
  22. [comment]: #
  23. [comment]: # package.1: package.md
  24. [comment]: # lowdown -s -Tman -o $@ $<
  25. [comment]: #
  26. [comment]: # And add lowdown to the Build-Depends control field.
  27. [comment]: # Remove the lines starting with '[comment]:' in this file in order
  28. [comment]: # to avoid warning messages.
  29. # NAME
  30. kbdled - program to do something
  31. # SYNOPSIS
  32. **kbdled** **-e** _this_ [**\-\-example=that**] [{**-e** | **\-\-example**} _this_]
  33. [{**-e** | **\-\-example**} {_this_ | _that_}]
  34. **kbdled** [{**-h** | *\-\-help**} | {**-v** | **\-\-version**}]
  35. # DESCRIPTION
  36. This manual page documents briefly the **kbdled** and **bar** commands.
  37. This manual page was written for the Debian distribution because the
  38. original program does not have a manual page. Instead, it has documentation
  39. in the GNU info(1) format; see below.
  40. **kbdled** is a program that...
  41. # OPTIONS
  42. The program follows the usual GNU command line syntax, with long options
  43. starting with two dashes ('-'). A summary of options is included below. For
  44. a complete description, see the **info**(1) files.
  45. **-e** _this_, **\-\-example=**_that_
  46. : Does this and that.
  47. **-h**, **\-\-help**
  48. : Show summary of options.
  49. **-v**, **\-\-version**
  50. : Show version of program.
  51. # FILES
  52. /etc/foo.conf
  53. : The system-wide configuration file to control the behaviour of
  54. kbdled. See **foo.conf**(5) for further details.
  55. ${HOME}/.foo.conf
  56. : The per-user configuration file to control the behaviour of
  57. kbdled. See **foo.conf**(5) for further details.
  58. # ENVIRONMENT
  59. **FOO_CONF**
  60. : If used, the defined file is used as configuration file (see also
  61. the section called “FILES”).
  62. # DIAGNOSTICS
  63. The following diagnostics may be issued on stderr:
  64. Bad configuration file. Exiting.
  65. : The configuration file seems to contain a broken configuration
  66. line. Use the **\-\-verbose** option, to get more info.
  67. **kbdled** provides some return codes, that can be used in scripts:
  68. Code Diagnostic
  69. 0 Program exited successfully.
  70. 1 The configuration file seems to be broken.
  71. # BUGS
  72. The program is currently limited to only work with the foobar library.
  73. The upstream BTS can be found at http://bugzilla.foo.tld.
  74. # SEE ALSO
  75. **bar**(1), **baz**(1), **foo.conf**(5)
  76. The programs are documented fully by The Rise and Fall of a Fooish Bar
  77. available via the **info**(1) system.
  78. # AUTHOR
  79. devnull <debian@siningsoft.de>
  80. : Wrote this manpage for the Debian system.
  81. # COPYRIGHT
  82. Copyright © 2007 devnull
  83. This manual page was written for the Debian system (and may be used by
  84. others).
  85. Permission is granted to copy, distribute and/or modify this document under
  86. the terms of the GNU General Public License, Version 2 or (at your option)
  87. any later version published by the Free Software Foundation.
  88. On Debian systems, the complete text of the GNU General Public License
  89. can be found in /usr/share/common-licenses/GPL.
  90. [comment]: # Local Variables:
  91. [comment]: # mode: markdown
  92. [comment]: # End: