Browse Source

Add draft man page.

Add a rudimentary man page for the yki program.
master
parent
commit
a57942077d
  1. 1
      .gitignore
  2. 2
      Makefile.am
  3. 3
      configure.ac
  4. 1
      man/Makefile.am
  5. 52
      man/yki.1.in

1
.gitignore

@ -19,3 +19,4 @@ src/.deps
src/yki
src/resources.c
extra/*.desktop
man/*.1

2
Makefile.am

@ -1,4 +1,4 @@
SUBDIRS = src extra
SUBDIRS = src extra man
ACLOCAL_AMFLAGS = -I m4 --install

3
configure.ac

@ -28,7 +28,8 @@ AM_PATH_GPGME([],
[AC_MSG_ERROR([libgpgme not found])])
dnl Output files
AC_CONFIG_FILES([Makefile src/Makefile extra/Makefile])
AC_CONFIG_FILES([Makefile src/Makefile extra/Makefile
man/Makefile man/yki.1])
AC_OUTPUT
dnl Summary

1
man/Makefile.am

@ -0,0 +1 @@
man_MANS = yki.1

52
man/yki.1.in

@ -0,0 +1,52 @@
.TH YKI 1 2020-05-04 "Yorkie @PACKAGE_VERSION@" "Yorkie Manual"
.SH NAME
Yorkie \- A task-oriented GnuPG frontend
.SH SYNOPSIS
.SY yki
.RB [ \-h | --help ]
.RB [ \-e | --encrypt ]
.RB [ \-d | --decrypt ]
.B file
.YS
.SH DESCRIPTION
.PP
.B Yorkie
provides a graphical interface for common GnuPG
operations such as encrypting or decrypting a file.
.SH OPTIONS
.TP
.BR -h ", " --help
Display the help message.
.TP
.BR -e ", " --encrypt
Launch the graphical interface to encrypt and/or
sign the specified file. This is the default.
.TP
.BR -d ", " --decrypt
Launch the graphical interface to decrypt and/or
verify the specified file.
.I Not implemented yet.
.SH REPORTING BUGS
.PP
Report bugs to
.MT @PACKAGE_BUGREPORT@
Damien Goutte-Gattat
.ME .
.SH SEE ALSO
.BR gpg (1)
.SH COPYRIGHT
.ad l
.PP
Copyright \(co 2020 Damien Goutte-Gattat
.PP
This program is released under the GNU General Public License.
See the COPYING file in the source distribution or
.UR https://www.gnu.org/licenses/gpl.html
.UE .
Loading…
Cancel
Save