shellapi.1

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.13.
.TH GENAPP "1" "October 2026" "Genapp 1.1.4" "User Commands"
.SH NAME
Genapp \- shell-api
.SH SYNOPSIS
.B genapp
\fI\,OPTIONS <application name>\/\fR
.PP
Arguments:
.TP
<application name>
a word identifying the app, starting with an uppercase (will be enforced)
.PP
OPTIONS:
.PP
\fB\-\-author\fR =<TEXTE>
.IP
Author of the app to generate
.PP
\fB\-\-config\fR
.IP
Show the configuration file content
.PP
\fB\-\-desc\fR =<TEXTE>
.IP
Description of the app to generate
.PP
\fB\-\-email\fR =<TEXTE>
.IP
Official contact email for the app to generate
.PP
\fB\-\-github\-id\fR =<TEXTE>
.IP
User id to use to build the github URL for the debian
package homepage definition of the generated app
.PP
\fB\-\-help\fR, \fB\-h\fR
.IP
Display Genapp usage
.PP
\fB\-\-http\fR =<URL>
.IP
URL for the debian package homepage of the app to generate
.PP
\fB\-\-man\fR
.IP
Display the Genapp manual page
.PP
\fB\-\-root\-release\-dir\fR =<FOLDER PATH>
.IP
software release folder for the generated app
.PP
\fB\-\-verbose\fR
.IP
Verbose mode
.PP
\fB\-v\fR, \fB\-\-version\fR
.IP
Display the Genapp version
.PP
\fB\-y\fR
.IP
Assume 'Yes' when prompted for confirmation
.SH DESCRIPTION
Genapp tool generates shell script app skeletons that build upon the shell\-api library. The generated skeletons are immediately operational and ready for the app implementation. It will generate the following files:
.PP
\- COPYRIGHT.txt : copyright notice
.PP
\- LICENSE.txt: MIT by default, to be replaced if necessary
.PP
\- CHANGELOG.txt: to be filled out as versions are released
.PP
\- EXAMPLES.txt: List of examples. Indentation matters for manpage.
.PP
\- <yourapp>__options.sh: file for managing options. For default ones, see doc.
.PP
\- <yourapp>__help.h: file providing help functions.
.PP
\- <yourapp>__vars.h: file containing the app\-specific global variables
.PP
\- <yourapp>: application skeleton
.PP
\- pack/debian/control : for packaging with dpkg
.SH "OPTIONS DETAILS"
\fB\-\-author\fR <TEXTE>
.IP
Specifies the author of the generated app as it will appear in the source file
headers, copyright notices and debian packages
.PP
\fB\-\-config\fR
.IP
Shows the configuration file content
.PP
\fB\-\-desc\fR <TEXTE>
.IP
Supplies a description of the app to generate
.PP
\fB\-\-email\fR <TEXTE>
.IP
Specifies the generated app's official contact email, typically the author's
one, as it will appear in the source file headers, copyright notices and debian
packages
.PP
\fB\-\-github\-id\fR <TEXTE>
.IP
Supplies the github id to use to build https github URL for the debian package
when \fB\-\-http\fR is not specified
.PP
\fB\-\-help\fR, \fB\-h\fR
.IP
Displays Genapp usage
.PP
\fB\-\-http\fR <URL>
.IP
Specifies the URL for the debian package homepage of the generated app.
If none is supplied the default URL is https://github/<github user
id>/<appname>,
where <github user id> is specified with \fB\-\-github\-id\fR
.PP
\fB\-\-man\fR
.IP
Displays the Genapp manual page. The output can be used to generate regular MAN
PAGES
.PP
\fB\-\-root\-release\-dir\fR <FOLDER PATH>
.IP
Specifies the path to the root folder where are stored software release for the
generated app.
The folder path shall be relative to the application source folder.
A subfolder will be created below the release folder for the generated app,
therefore the release folder can be used for other apps as well.
.PP
\fB\-\-verbose\fR
.IP
Verbose mode
.PP
\fB\-v\fR, \fB\-\-version\fR
.IP
Displays the Genapp version. The output can be used to generate regular debian
packages
.PP
\fB\-y\fR
.IP
Assume 'Yes' answer for any confirmation request
.SH EXAMPLES
Generate a test app
.IP
# An app named 'TestApp' is generated, inside folder 'testapp', main script will be 'testapp'. The home page URL for the app will be https://github/michelm33/testapp
.IP
genapp TestApp \-y \-\-author="George W" \-\-email="george.w@wh.org" \-\-desc="A test application" \-\-github\-id="michelm33" \-\-root\-release\-dir="../release"
.IP
# Same as previous example, but the home page URL for the app is explicitly defined as 'https://slashetc/testapp'
.IP
genapp TestApp \-y \-\-author="George W" \-\-email="george.w@wh.org" \-\-desc="A test application" \-\-http="https://slashetc/testapp" \-\-root\-release\-dir="../release"
.PP
Execute the generated app
.IP
# 'TestApp' is the generated app
.IP
\&./testapp
.PP
Show the app help
.IP
# 'TestApp' is the generated app
.IP
\&./testapp \-h
.PP
Show the last 30 log lines
.IP
# 'TestApp' is the generated app
.IP
\&./testapp \-\-log=30
.PP
Show the files managed by the app
.IP
# 'TestApp' is the generated app
.IP
\&./testapp \-\-files
.PP
Generate a debian package
.IP
# This generates a release file tree and a debian package
.IP
make release
.PP
Generate the man pages
.IP
# This generates the manpage which can be open using 'man testapp'
.IP
make man
.IP
man testapp
.SH AUTHOR
Written by Michel MEHL
.SH "REPORTING BUGS"
Report bugs to <michel.mehl@slashetc.fr>
.SH COPYRIGHT
Copyright \(co 2024\-2026 Michel Mehl.
All rights reserved.
Tous droits réservés (France).
.PP
License terms written down in file LICENSE.txt
Les termes de la licence sont détaillés dans le fichier LICENSE.txt