webapp/postfixadmin
1
0
Fork 0
mirror of https://github.com/postfixadmin/postfixadmin.git synced 2025-08-09 05:02:44 +03:00
Code Activity

add a manpage for postfixadmin-cli(1)

Browse Source
This commit is contained in:
Jing Luo
2024-11-30 16:37:23 +09:00
committed by David Goodwin
parent f1153a09ab
commit 586389c2d1
2 changed files with 72 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
debian/manpage/postfixadmin-cli.1 vendored Normal file
View File

@@ -0,0 +1,71 @@
.TH "postfixadmin\-cli" "1" "2024-11-30" "PostfixAdmin" "postfixadmin-cli"
.SH Name
postfixadmin-cli \- a CLI tool to manage postfixadmin
.SH SYNOPSIS
\fBpostfixadmin-cli\fP \fI<module> <task>\fP \fB[options]\fP
.P
\fBpostfixadmin-cli\fP \fI<module>\fP \fBhelp\fP
.P
\fBpostfixadmin-cli\fP \fI<module> <task>\fP \fBhelp\fP
.SH DESCRIPTION
.B postfixadmin-cli
is a CLI tool to use postfixadmin like how you use the WebUI. It is a
shell sciprt wrapped around
\fI/usr/share/postfixadmin/scripts/postfixadmin-cli.php\fP.
.SH MODULES
.IP \fBadmin\fP
.IP \fBdomain\fP
.IP \fBmailbox\fP
.IP \fBalias\fP
.IP \fBaliasdomain\fP
.IP \fBfetchmail\fP
.SH TASKS
Most modules support the following tasks:
.IP \fBview\fP
View an item.
.IP \fBadd\fP
Add an item.
.IP \fBupdate\fP
Update an item.
.IP \fBdelete\fP
Delete an item.
.IP \fBscheme\fP
Print database scheme (useful for developers only).
.IP \fBhelp\fP
Print help output.
.SH OPTIONS
Different combinations of \fBMODULES\fP and \fBTASKS\fP have different
sets of available options to use. Please see the help messages and
the examples below.
.SH EXAMPLES
To add a mailbox interactively:
.P
.B postfixadmin-cli \fImailbox add\fP
.P
To add a mailbox non-interactively, with the new mailbox being inactive:
.P
.B postfixadmin-cli \fImailbox add\fP \fRnobody@example.com\fP
.B --password \fRdeadbeef12\fP --password2 \fRdeadbeef12\fP --name
.B \fR"Nobody Nogroup"\fP --welcome-mail --active \fR0\fP
.B --email-other \fRbackup@example.com\fP
.P
To view the information of a domain:
.P
.B postfixadmin-cli \fIdomain view\fP \fRexample.com\fP
.P
.SH REPORTING BUGS
Please report bugs to the Debian BTS, i.e. using \fBreportbug\fP(1).
.SH SEE ALSO
\fBpostfix\fP(1),
\fBpostconf\fP(1),
\fBpostmap\fP(1),
\fBmariadb\fP(1),
\fBpsql\fP(1),
\fBphp\fP(1)
.SH AUTHOR
Copyright 2024 Jing Luo.
.P
This manpage was written by Jing Luo, licensed under the terms of GNU
General Pulic License version 2, or at your option any later version.
There is absolutely no warranty; see \fI/usr/share/common-licenses/GPL-2\fR
for the terms of the license.

1
debian/postfixadmin.manpages vendored Normal file
View File

@@ -0,0 +1 @@
debian/manpage/postfixadmin-cli.1