* Added new man pages, after battles with Make...
This commit is contained in:
+3
-1
@@ -138,7 +138,8 @@ include_subdirs := \
|
||||
src/apps/storetool \
|
||||
src/apps/storetool/demo \
|
||||
src/www \
|
||||
zoneinfo
|
||||
zoneinfo \
|
||||
man
|
||||
|
||||
# src/apps/migrate
|
||||
|
||||
@@ -205,6 +206,7 @@ include src/apps/storetool/Bongo.rules
|
||||
include src/apps/storetool/demo/Bongo.rules
|
||||
include src/www/Bongo.rules
|
||||
include zoneinfo/Bongo.rules
|
||||
include man/Bongo.rules
|
||||
|
||||
update-makefiles:
|
||||
@for dir in $(include_subdirs) ; do \
|
||||
|
||||
@@ -727,4 +727,5 @@ src/libs/connmgr/Makefile
|
||||
src/www/Makefile
|
||||
src/www/bongo.conf
|
||||
zoneinfo/Makefile
|
||||
man/Makefile
|
||||
])
|
||||
|
||||
@@ -0,0 +1,54 @@
|
||||
mannormal = man/bongo-admin.1 \
|
||||
man/bongo-backup.1 \
|
||||
man/bongo-config.1 \
|
||||
man/bongo-manager.1 \
|
||||
man/bongo-queuetool.1 \
|
||||
man/bongo-setup.1 \
|
||||
man/bongo-sendmail.1 \
|
||||
man/bongo-standalone.1 \
|
||||
man/bongo-storetool.1 \
|
||||
man/mdbtool.1 \
|
||||
man/bongoagents.8
|
||||
|
||||
mansymlinked = man/bongoaddressbook.8 \
|
||||
man/bongoalarm.8 \
|
||||
man/bongoantispam.8 \
|
||||
man/bongoavirus.8 \
|
||||
man/bongocalcmd.8 \
|
||||
man/bongocollector.8 \
|
||||
man/bongoconnmgr.8 \
|
||||
man/bongogeneric.8 \
|
||||
man/bongoimap.8 \
|
||||
man/bongoitip.8 \
|
||||
man/bongomailprox.8 \
|
||||
man/bongopluspack.8 \
|
||||
man/bongopop3.8 \
|
||||
man/bongoqueue.8 \
|
||||
man/bongorules.8 \
|
||||
man/bongosmtp.8 \
|
||||
man/bongostore.8
|
||||
|
||||
man/bongo%.8:
|
||||
cd man && ln -s bongoagents.8 bongo$*.8
|
||||
|
||||
dist_man_MANS = $(mannormal)
|
||||
nodist_man_MANS = $(mansymlinked)
|
||||
|
||||
CLEANFILES += man/bongoaddressbook.8 \
|
||||
man/bongoalarm.8 \
|
||||
man/bongoantispam.8 \
|
||||
man/bongoavirus.8 \
|
||||
man/bongocalcmd.8 \
|
||||
man/bongocollector.8 \
|
||||
man/bongoconnmgr.8 \
|
||||
man/bongogeneric.8 \
|
||||
man/bongoimap.8 \
|
||||
man/bongoitip.8 \
|
||||
man/bongomailprox.8 \
|
||||
man/bongopluspack.8 \
|
||||
man/bongopop3.8 \
|
||||
man/bongoqueue.8 \
|
||||
man/bongorules.8 \
|
||||
man/bongosmtp.8 \
|
||||
man/bongostore.8
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
# -*- Makefile -*-
|
||||
#
|
||||
# Do not edit!
|
||||
#
|
||||
# (unless this is Makefile.am.subdir)
|
||||
#
|
||||
# This file is a copy of the toplevel Makefile.am.subdir. If changes
|
||||
# need to be made, edit that file, and make update-makefiles, and
|
||||
# check the new files in.
|
||||
#
|
||||
# This is a skeletal automake file. The real automake fules for
|
||||
# building the targets for this directory can be found in the
|
||||
# Bongo.rules file. This file is simply here so that 'make all' can
|
||||
# work in each subdirectory.
|
||||
|
||||
all clean install:
|
||||
@cd $(top_builddir) && $(MAKE) $(MFLAGS) $(subdir)/$@
|
||||
@@ -0,0 +1,105 @@
|
||||
.TH "bongo-admin" 1 "Bongo Project" "http://bongo-project.org/"
|
||||
.SH "NAME"
|
||||
bongo-admin \(em Bongo Administration Utility
|
||||
.SH "SYNOPSIS"
|
||||
.PP
|
||||
.B bongo-admin
|
||||
.RI [ options ]
|
||||
.I COMMAND
|
||||
.RI [ command-options ]
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
This manual page documents briefly the
|
||||
.B bongo-manager
|
||||
command.
|
||||
.PP
|
||||
.B bongo-manager
|
||||
is a program to administrate the Bongo server.
|
||||
.SH "OPTIONS"
|
||||
.PP
|
||||
A summary of options is included below.
|
||||
.TP
|
||||
.BR \-h ", " \-\^\-help
|
||||
Help. Display available commands.
|
||||
.TP
|
||||
.BI \-U " AUTHUSER" "\fR,\fP \-\^\-authuser=" AUTHUSER
|
||||
Admin username. Defaults to admin.
|
||||
.TP
|
||||
.BI \-P " AUTHPASS" "\fR,\fP \-\^\-authpass=" AUTHPASS
|
||||
Admin password.
|
||||
.TP
|
||||
.BI \-c " CONTEXT" "\fR,\fP \-\^\-context=" CONTEXT
|
||||
MDB context.
|
||||
.TP
|
||||
.BR \-\^\-debug
|
||||
Enable debugging output.
|
||||
.SH "AGENT COMMANDS"
|
||||
.TP
|
||||
.BR agent-delete ", " ad
|
||||
Delete a Bongo agent.
|
||||
.TP
|
||||
.BR agent-info ", " ai
|
||||
List info for an agent.
|
||||
.TP
|
||||
.BR agent-list ", " al
|
||||
List configured Bongo agents.
|
||||
.TP
|
||||
.BR agent-modify ", " am
|
||||
Modify a Bongo agent.
|
||||
.SH "OTHER COMMANDS"
|
||||
.TP
|
||||
.BR demo
|
||||
Create a demo user
|
||||
.SH "SERVER COMMANDS"
|
||||
.TP
|
||||
.BR server-info ", " si
|
||||
List information about configured Bongo servers.
|
||||
.TP
|
||||
.BR server-list ", " sl
|
||||
List configured Bongo servers.
|
||||
.SH "SETUP COMMANDS"
|
||||
.TP
|
||||
.BR import
|
||||
Import a
|
||||
.B bongo-setup.xml
|
||||
tree.
|
||||
.TP
|
||||
.BR setup-genschema
|
||||
Generate directory schema.
|
||||
.TP
|
||||
.BR setup-mdb
|
||||
Configure an MDB tree.
|
||||
.TP
|
||||
.BR setup-rights
|
||||
Grant access to Bongo services on the Bongo tree.
|
||||
.TP
|
||||
.BR setup-ssl
|
||||
Generate or install an SSL key/cert pair.
|
||||
.TP
|
||||
.BR setup-system-credential
|
||||
Generate Bongo system agent credential.
|
||||
.SH "USER COMMANDS"
|
||||
.TP
|
||||
.BR user-add ", " ua
|
||||
Add a Bongo user.
|
||||
.TP
|
||||
.BR user-delete ", " ud
|
||||
Delete a Bongo user.
|
||||
.TP
|
||||
.BR user-info ", " ui
|
||||
Display information about a Bongo user.
|
||||
.TP
|
||||
.BR user-list ", " ul
|
||||
List Bongo users.
|
||||
.TP
|
||||
.BR user-modify ", " um
|
||||
Modify a Bongo user.
|
||||
.TP
|
||||
.BR user-passwd ", " up
|
||||
Change a Bongo user's password.
|
||||
.SH "SEE ALSO"
|
||||
.PP
|
||||
bongo-setup(1), bongo-admin(1)
|
||||
.SH "AUTHOR"
|
||||
.PP
|
||||
This manual page was written by Jonny Lamb <jonnylamb@jonnylamb.com>.
|
||||
@@ -0,0 +1,61 @@
|
||||
.TH "bongo-backup" 1 "Bongo Project" "http://bongo-project.org/"
|
||||
.SH NAME
|
||||
bongo-backup \- Backup and restores a Bongo document store
|
||||
.SH SYNOPSIS
|
||||
.B bongo-backup
|
||||
.RI [ options ]
|
||||
.I COMMAND
|
||||
.SH DESCRIPTION
|
||||
.B bongo-backup
|
||||
can create backups of, and then restore these backups to, a Bongo document store. It takes a
|
||||
.I COMMAND
|
||||
on execution to specify its action.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BI \-h " HOSTNAME" "\fR,\fP \-\^\-host=" HOSTNAME
|
||||
Host of Bongo store. Defaults to 127.0.0.1.
|
||||
.TP
|
||||
.BI \-p " PASSWORD" "\fR,\fP \-\^\-passwd=" PASSWORD
|
||||
Specify password to authenticate.
|
||||
.TP
|
||||
.BI \-s " PATH" "\fR,\fP \-\^\-store=" PATH
|
||||
Path to local backup store.
|
||||
.TP
|
||||
.BI \-u " USER" "\fR,\fP \-\^\-user=" USER
|
||||
Username used to authenticate.
|
||||
.TP
|
||||
.BR \-v ", " \-\^\-verbose
|
||||
Display verbose output.
|
||||
.SH COMMANDS
|
||||
.TP
|
||||
.BR backup " [user[:guid[,..]][ ..]]"
|
||||
Appends incremental backup to the store.
|
||||
.TP
|
||||
.BR restore " [user[:guid[,..]][ ..]]"
|
||||
Restores documents from store to server.
|
||||
.TP
|
||||
.BR search " [filter[,..]]"
|
||||
Searches the store for documents.
|
||||
.TP
|
||||
.BR rollback " [MM/DD/YYYY]"
|
||||
Permanently deletes data store after date.
|
||||
.SH "SEARCH FILTERS"
|
||||
.TP
|
||||
.BI "after=" [MM/DD/YYYY]
|
||||
Only search documents after this date.
|
||||
.TP
|
||||
.BI "before=" [MM/DD/YYY]
|
||||
Only search documents before this date.
|
||||
.TP
|
||||
.BI "string=" [string[:..]]
|
||||
String search. Strings may be enclosed in single quotes.
|
||||
.TP
|
||||
.BI "type=" [type[:..]]
|
||||
Only search type(s) (mail, cab, ab)
|
||||
.TP
|
||||
.BI "user=" [user[:..]]
|
||||
Only search documents owned by user(s)
|
||||
.SH "AUTHOR"
|
||||
This man page was written by Jonny Lamb <jonnylamb@jonnylamb.com>.
|
||||
.SH "SEE ALSO"
|
||||
bongo-setup(1), bongo-admin(1)
|
||||
@@ -0,0 +1,30 @@
|
||||
.TH "bongo-config" 1 "Bongo Project" "http://bongo-project.org/"
|
||||
.SH NAME
|
||||
bongo-config \- configures parts of the Bongo server
|
||||
.SH SYNOPSIS
|
||||
.B bongo-config
|
||||
.RI [ options ]
|
||||
.I COMMAND
|
||||
.SH DESCRIPTION
|
||||
.B bongo-config
|
||||
installs the necessary configuration to the Bongo Store. It takes a
|
||||
.I COMMAND
|
||||
on execution to specify its action.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BR \-v ", " \-\^\-verbose
|
||||
Show verbose output.
|
||||
.SH COMMANDS
|
||||
.TP
|
||||
.BR install
|
||||
Do the initial Bongo install.
|
||||
.TP
|
||||
.BR crypto
|
||||
Generate data needed for encryption.
|
||||
.TP
|
||||
.BR checkversion
|
||||
Check whether a newer Bongo is available.
|
||||
.SH "AUTHOR"
|
||||
This man page was written by Jonny Lamb <jonnylamb@jonnylamb.com>.
|
||||
.SH "SEE ALSO"
|
||||
bongo-setup(1), bongo-admin(1)
|
||||
@@ -0,0 +1,38 @@
|
||||
.TH "bongo-manager" 1 "Bongo Project" "http://bongo-project.org/"
|
||||
.SH "NAME"
|
||||
bongo-manager \(em Bongo Management Utility
|
||||
.SH "SYNOPSIS"
|
||||
.PP
|
||||
.B bongo-manager
|
||||
.RI [ options ]
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
This manual page documents briefly the
|
||||
.B bongo-manager
|
||||
command.
|
||||
.PP
|
||||
.B bongo-manager
|
||||
is a program to manage the Bongo server.
|
||||
.SH "OPTIONS"
|
||||
.PP
|
||||
A summary of options is included below.
|
||||
.TP
|
||||
.BR \-h ", " \-\^\-help
|
||||
Help. Display available commands.
|
||||
.TP
|
||||
.BR \-r ", " \-\^\-restart
|
||||
Restart running Bongo agents.
|
||||
.TP
|
||||
.BR \-\^\-status
|
||||
Report on running Bongo agents.
|
||||
.TP
|
||||
.BR \-s ", " \-\^\-stop
|
||||
Terminate running Bongo agents.
|
||||
.SH "SEE ALSO"
|
||||
.PP
|
||||
bongo-setup(1), bongo-admin(1)
|
||||
.SH "AUTHOR"
|
||||
.PP
|
||||
This manual page was originally written by Alex Hudson <home@alexhudson.com> for the
|
||||
.B Debian
|
||||
system (but may be used by others) and was updated by Jonny Lamb <jonnylamb@jonnylamb.com>. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2, as published by the Free Software Foundation.
|
||||
@@ -0,0 +1,34 @@
|
||||
.TH "bongo-queuetool" 1 "Bongo Project" "http://bongo-project.org/"
|
||||
.SH NAME
|
||||
bongo-queuetool \- Manges the Bongo Queue agent
|
||||
.SH SYNOPSIS
|
||||
.B bongo-queuetool
|
||||
.RI [ options ]
|
||||
.I COMMAND
|
||||
.RI [ command-options ]
|
||||
.SH DESCRIPTION
|
||||
.B bongo-queuetool
|
||||
manages the operation of the Bongo Queue. It takes a
|
||||
.I COMMAND
|
||||
on execution to specify its action.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BR \-h ", " \-\^\-help
|
||||
Show help message and exit.
|
||||
.TP
|
||||
.BI "\-\^\-host=" HOSTNAME
|
||||
Host of Bongo queue. Defaults to localhost.
|
||||
.TP
|
||||
.BI "\-\^\-port=" PORT
|
||||
Port of Bongo queue. Defaults to 8670.
|
||||
.TP
|
||||
.BR \-\^\-debug
|
||||
Enable debugging output.
|
||||
.SH "QUEUE MANAGEMENT COMMANDS"
|
||||
.TP
|
||||
.BR flush " (f)"
|
||||
Flush the mail queue.
|
||||
.SH "AUTHOR"
|
||||
This man page was written by Jonny Lamb <jonnylamb@jonnylamb.com>.
|
||||
.SH "SEE ALSO"
|
||||
bongo-setup(1), bongo-admin(1)
|
||||
@@ -0,0 +1,41 @@
|
||||
.TH "bongo-sendmail" 1 "Bongo Project" "http://bongo-project.org/"
|
||||
.SH "NAME"
|
||||
bongo-sendmail \(em bongo Sendmail
|
||||
.SH "SYNOPSIS"
|
||||
.PP
|
||||
.B bongo-sendmail
|
||||
.RI [ options ]
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
The
|
||||
.B bongo-sendmail
|
||||
command attempts to implement an LSB-compliant sendmail interface direct to the Bongo Queue agent. Most useful options are implemented; some are not.
|
||||
.PP
|
||||
.B bongo-sendmail
|
||||
will continue to read input from standard input until it sees either a dot alone on a line, or reaches the end of file.
|
||||
.SH "OPTIONS"
|
||||
.PP
|
||||
A summary of options is included below.
|
||||
.TP
|
||||
.BI \-r " mail_from"
|
||||
Set the From: header of the mail being sent.
|
||||
.TP
|
||||
.BI \-F " env_from"
|
||||
Set the sender address on the mail envelope.
|
||||
.TP
|
||||
.BR \-i
|
||||
Read the entire standard input until the end of the file.
|
||||
.TP
|
||||
.BR \-bm
|
||||
From from stndard input until a . appears alone on a line.
|
||||
.TP
|
||||
.BR \-o
|
||||
-oi is equivalent to -i; other arguments are ignored.
|
||||
.TP
|
||||
.BR \-t
|
||||
Extract recipient addresses from the mail body.
|
||||
.SH "AUTHOR"
|
||||
.PP
|
||||
This manual page was originally written by Alex Hudson <home@alexhudson.com> for the
|
||||
.B Debian
|
||||
system (but may be used by others) and was updated by Jonny Lamb <jonnylamb@jonnylamb.com>. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2, as published by the Free Software Foundation.
|
||||
@@ -0,0 +1,72 @@
|
||||
.TH "bongo-setup" 1 "Bongo Project" "http://bongo-project.org/"
|
||||
.SH NAME
|
||||
bongo-setup \- Sets up the Bongo server
|
||||
.SH SYNOPSIS
|
||||
.B bongo-setup
|
||||
.RI [ options ]
|
||||
.SH DESCRIPTION
|
||||
.B bongo-setup
|
||||
installs the initial configuration in readiness for running the Bongo server.
|
||||
.B bongo-setup
|
||||
should be run after installing, and before trying to run Bongo itself.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BR \-h ", " \-\^\-help
|
||||
Show help message and exit.
|
||||
.TP
|
||||
.BR \-n ", " \-\^\-noprompt
|
||||
Run non-interactively.
|
||||
.TP
|
||||
.BI \-H " HOSTNAME" "\fR,\fP \-\^\-hostname=" HOSTNAME
|
||||
Hostname of this Bongo server.
|
||||
.TP
|
||||
.BI \-M " MAILDOMAIN" "\fR,\fP \-\^\-maildomain=" MAILDOMAIN
|
||||
Domain we accept mail for.
|
||||
.TP
|
||||
.BI \-f " FILE" "\fR,\fP \-\^\-file=" FILE
|
||||
Import objects from XML file
|
||||
.I FILE
|
||||
.TP
|
||||
.BI \-S " TARGET" "\fR,\fP \-\^\-gen-schema=" TARGET
|
||||
Generate schema for
|
||||
.I TARGET
|
||||
(ad, edir, mdb, openldap).
|
||||
.TP
|
||||
.BI \-a " NOACL" "\fR,\fP \-\^\-noacl=" NOACL
|
||||
Do not set up ACLs.
|
||||
.TP
|
||||
.BI \-m " MDB_DRIVER" "\fR,\fP \-\^\-mdb-driver=" MDB_DRIVER
|
||||
Specify directory driver (file, ldap, managed-slapd); Default is managed-slapd.
|
||||
.TP
|
||||
.BI \-b " BASE" "\fR,\fP \-\^\-base=" BASE
|
||||
Base directory for Bongo.
|
||||
.TP
|
||||
.BI "\-\^\-managed-slapd-path=" PATH
|
||||
Path to your slapd bianry. Default is /usr/sbin/slapd
|
||||
.TP
|
||||
.BI "\-\^\-managed-slapd-port=" PORT
|
||||
Port for managed slapd. Default is 8983.
|
||||
.SH SSL OPTIONS
|
||||
.TP
|
||||
.BI \-r " FILE" "\fR,\fP \-\^\-cert=" FILE
|
||||
Use certificate file
|
||||
.I FILE
|
||||
.TP
|
||||
.BI \-k " FILE" "\fR,\fP \-\^\-key=" FILE
|
||||
Use private key file
|
||||
.I FILE
|
||||
.SH LDAP OPTIONS
|
||||
.TP
|
||||
.BI \-u " AUTHUSER" "\fR,\fP \-\^\-authuser=" AUTHUSER
|
||||
User for directory authentication (only available when
|
||||
.B --mdb-driver=ldap
|
||||
)
|
||||
.TP
|
||||
.BI \-p " AUTHPASS" "\fR,\fP \-\^\-authpass=" AUTHPASS
|
||||
Password for directory authentication (only available when
|
||||
.B --mdb-driver=ldap
|
||||
)
|
||||
.SH "AUTHOR"
|
||||
This man page was written by Jonny Lamb <jonnylamb@jonnylamb.com>.
|
||||
.SH "SEE ALSO"
|
||||
bongo-config(1), bongo-admin(1)
|
||||
@@ -0,0 +1,51 @@
|
||||
.TH "bongo-standalone" 1 "Bongo Project" "http://bongo-project.org/"
|
||||
.SH NAME
|
||||
bongo-standalone \- Bongo standalone web server
|
||||
.SH SYNOPSIS
|
||||
.B bongo-standalone
|
||||
.RI [ options ]
|
||||
.SH DESCRIPTION
|
||||
.B bongo-standalone
|
||||
is a standalone Bongo web server. It is written in Python and is useful for running Bongo without Apache.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BR \-h ", " \-\^\-help
|
||||
Show help message and exit.
|
||||
.TP
|
||||
.BR \-d ", " \-\^\-debug
|
||||
Enable debugging output.
|
||||
.TP
|
||||
.BR \-D ", " \-\^\-devel
|
||||
Development mode (implies
|
||||
.B \-d
|
||||
).
|
||||
.TP
|
||||
.BR \-\^\-profile
|
||||
Enable profiling output.
|
||||
.TP
|
||||
.BR \-\^\-profile-memory
|
||||
Enable memory profiling (requires sizer).
|
||||
.TP
|
||||
.BR \-\^\-ssl
|
||||
Enable SSL.
|
||||
.TP
|
||||
.BI \-p " PORT" "\fR,\fP \-\^\-port=" PORT
|
||||
Specify port for the HTTP server. Defaults to 8080.
|
||||
.TP
|
||||
.BI \-s " SLEEP" "\fR,\fP \-\^\-sleep=" SLEEP
|
||||
TODO. Defaults to 0
|
||||
.TP
|
||||
.BR \-a ", " \-\^\-auth-always
|
||||
Authenticate all requests.
|
||||
.TP
|
||||
.BR \-\^\-no-dns
|
||||
Disable reverse DNS lookups for logging.
|
||||
.TP
|
||||
.BI "\-\^\-file-path=" FILEPATH
|
||||
Specify a static file path,
|
||||
.I FILEPATH
|
||||
, to serve.
|
||||
.SH "AUTHOR"
|
||||
This man page was written by Jonny Lamb <jonnylamb@jonnylamb.com>.
|
||||
.SH "SEE ALSO"
|
||||
bongo-setup(1), bongo-admin(1)
|
||||
@@ -0,0 +1,101 @@
|
||||
.TH "bongo-queuetool" 1 "Bongo Project" "http://bongo-project.org/"
|
||||
.SH NAME
|
||||
bongo-storetool \- Manges the Bongo store agent
|
||||
.SH SYNOPSIS
|
||||
.B bongo-storetool
|
||||
.RI [ options ]
|
||||
.I COMMAND
|
||||
.RI [ command-options ]
|
||||
.SH DESCRIPTION
|
||||
.B bongo-queuetool
|
||||
manages the operation of the Bongo store. It takes a
|
||||
.I COMMAND
|
||||
on execution to specify its action.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BR \-h ", " \-\^\-help
|
||||
Show help message and exit.
|
||||
.TP
|
||||
.BI "\-\^\-host=" HOSTNAME
|
||||
Host of Bongo queue. Defaults to localhost.
|
||||
.TP
|
||||
.BI "\-\^\-port=" PORT
|
||||
Port of Bongo queue. Defaults to 8670.
|
||||
.TP
|
||||
.BR \-\^\-debug
|
||||
Enable debugging output.
|
||||
.TP
|
||||
.BI \-u " USER" "\fR,\fP \-\^\-user=" USER
|
||||
Connect with user
|
||||
.I USER
|
||||
.TP
|
||||
.BI \-p " PASSWORD" "\fR,\fP \-\^\-password=" PASSWORD
|
||||
Connect with password
|
||||
.I PASSWORD
|
||||
.TP
|
||||
.BI \-s " STORE" "\fR,\fP \-\^\-store=" STORE
|
||||
Connect to store
|
||||
.I STORE
|
||||
, if different from user.
|
||||
.SH "CALENDAR COMMANDS"
|
||||
.TP
|
||||
.BR calendar-accept-share ", " cash
|
||||
Accept a specified calendar invitation.
|
||||
.TP
|
||||
.BR calendar-delete ", " cd
|
||||
Delete specified calender.
|
||||
.TP
|
||||
.BR calendar-events ", " ce
|
||||
List the events in a calendar.
|
||||
.TP
|
||||
.BR calendar-import ", " ci
|
||||
Import a specified calendar file.
|
||||
.TP
|
||||
.BR calendar-list ", " cl
|
||||
List the calendars in your store.
|
||||
.TP
|
||||
.BR calendar-list-shares ", " cls
|
||||
List sharing info for a given calendar.
|
||||
.TP
|
||||
.BR calendar-publish ", " cp
|
||||
Make a specified calendar public, and send an invitation.
|
||||
.TP
|
||||
.BR calendar-share ", " csh
|
||||
Share a calendar with a set of addresses.
|
||||
.TP
|
||||
.BR calendar-sub ", " cs
|
||||
Subscribe to specified calendar.
|
||||
.TP
|
||||
.BR calendar-unpublish ", " cup
|
||||
Make a specified calendar non-public.
|
||||
.TP
|
||||
.BR calendar-unshare ", " cush
|
||||
Revoke access from a given calendar.
|
||||
.TP
|
||||
.BR events-cleanup ", " ec
|
||||
Delete any events not linked with calendars.
|
||||
.TP
|
||||
.BR events-delete ", " ed
|
||||
Delete all events in the store.
|
||||
.SH "CONTACT COMMANDS"
|
||||
.TP
|
||||
.BR addressbook-contacts ", " ac
|
||||
List the contacts in an addressbook.
|
||||
.TP
|
||||
.BR addressbook-import ", " ai
|
||||
Import VCF data from files.
|
||||
.TP
|
||||
.BR addressbook-list ", " al
|
||||
List the addressbooks in your store.
|
||||
.SH "MAIL COMMANDS"
|
||||
.TP
|
||||
.BR mail-store ", " ms
|
||||
Store individual mail messages.
|
||||
.SH "OTHER COMMANDS"
|
||||
.TP
|
||||
.BR telnet ", " t
|
||||
Start an interactive telnet session.
|
||||
.SH "AUTHOR"
|
||||
This man page was written by Jonny Lamb <jonnylamb@jonnylamb.com>.
|
||||
.SH "SEE ALSO"
|
||||
bongo-setup(1), bongo-admin(1)
|
||||
@@ -0,0 +1,74 @@
|
||||
.TH "bongoagents" "8" "Bongo Project" "http://bongo-project.org/"
|
||||
.SH "NAME"
|
||||
bongoaddressbook, bongoalarm, bongoantispam, bongoavirus, bongocalcmd, bongocollector, bongoconnmgr, bongogeneric, bongoimap, bongoitip, bongomailprox, bongopluspack, bongopop3, bongoqueue, bongorules, bongosmtp, bongostore \(em Bongo Agents
|
||||
.SH "SYNOPSIS"
|
||||
.PP
|
||||
Bongo agents that manage a certain part of the server.
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
.TP
|
||||
.BR bongoaddressbook
|
||||
Address book agent.
|
||||
.TP
|
||||
.BR bongoalarm
|
||||
Alarm clock agent. This does e-mail notification of calendar events upcoming.
|
||||
.TP
|
||||
.BR bongoantispam
|
||||
Anti-spam agent. This currently only ties to the spamd process from SpamAssassin.
|
||||
.B bongoantispam
|
||||
will always add spam headers to mail no matter what the spam score or status of an email.
|
||||
.TP
|
||||
.BR bongoavirus
|
||||
Anti-virus agent. This agent connects to the clamd process of Clam anti-virus. It will scan all messages for viruses or phising content.
|
||||
.TP
|
||||
.BR bongocalcmd
|
||||
ical agent. This processes mail and if it appears as if it is calendar data, it will act accordingly.
|
||||
.TP
|
||||
.BR bongocollector
|
||||
Calendar collector agent. This gets calendar subscriptions for users.
|
||||
.TP
|
||||
.BR bongoconnmgr
|
||||
This agent is a common library used by all agents for network access.
|
||||
.B connmgr
|
||||
provides a coherent buffered network stack.
|
||||
.TP
|
||||
.BR bongogeneric
|
||||
An example agent.
|
||||
.TP
|
||||
.BR bongoimap
|
||||
IMAP agent, which translates the internal Bongo Store protocol to the RFC standard IMAP4 rev1 protocol (RFC-3501).
|
||||
.TP
|
||||
.BR bongoitip
|
||||
iCal Transport-Independant interoperability Protocol agent. This manages calendar invitations over e-mail (RFC-2446).
|
||||
.TP
|
||||
.BR bongomailprox
|
||||
Receives mail from a remote IMAP/POP mail server and adds it to a local mail account.
|
||||
.TP
|
||||
.BR bongopluspack
|
||||
The "plus pack" agent. This has several jobs, including keeping a copy of all mail passing throug hthe system.
|
||||
.TP
|
||||
.BR bongopop3
|
||||
POP3 agent, which translates the internal Bongo Store protocol to the RFC standard POP3 protocol (RFC-1939).
|
||||
.TP
|
||||
.BR bongoqueue
|
||||
Speaks to all other queue agents and moves mail through mail queues. Queues range from anti-spam to SMTP to IMAP.
|
||||
.TP
|
||||
.BR bongorules
|
||||
Server-side rules agent for mail. This is similar to how a mail client allows rules to be set up for handling mail, but on the server-side.
|
||||
.TP
|
||||
.BR bongosmtp
|
||||
SMTP agent, which translates the internal Bongo Queue protocol to the RFC standard SMTP protocol (RFC-2821).
|
||||
.TP
|
||||
.BR bongostore
|
||||
Bongo Store agent, which houses the mail for each user using an mbox format with custon indexing.
|
||||
.SH "OPTIONS"
|
||||
.PP
|
||||
These programs should never be called directly by the user, and thus have no command-line options.
|
||||
.SH "SEE ALSO"
|
||||
.PP
|
||||
bongo-manager(1), bongo-setup(1), bongo-admin(1)
|
||||
.SH "AUTHOR"
|
||||
.PP
|
||||
This manual page was originally written by Alex Hudson <home@alexhudson.com> for the
|
||||
.B Debian
|
||||
system (but may be used by others) and modified by Jonny Lamb <jonnylamb@jonnylamb.com>. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2, as published by the Free Software Foundation.
|
||||
@@ -0,0 +1,69 @@
|
||||
.TH "mdbtool" 1 "Bongo Project" "http://bongo-project.org/"
|
||||
.SH NAME
|
||||
mdbtool \- Manges the Bongo MDB agent
|
||||
.SH SYNOPSIS
|
||||
.B mdbtool
|
||||
.RI [ options ]
|
||||
.I COMMAND
|
||||
.SH DESCRIPTION
|
||||
.B mdbtool
|
||||
manages the operation of the Bongo MDB agent. It takes a
|
||||
.I COMMAND
|
||||
on execution to specify its action.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BR \-h ", " \-\^\-help
|
||||
Show help message and exit.
|
||||
.TP
|
||||
.BI \-p " PASSWORD" "\fR,\fP \-\^\-password=" PASSWORD
|
||||
Use password
|
||||
.I PASSWORD
|
||||
for authentication.
|
||||
.TP
|
||||
.BI \-u " USERNAME" "\fR,\fP \-\^\-username=" USERNAME
|
||||
Use username
|
||||
.I USERNAME
|
||||
for authentication.
|
||||
.SH "COMMANDS"
|
||||
.TP
|
||||
.BR getbasedn
|
||||
.TP
|
||||
.BI "getattrs " OBJECT " " ATTRNAME
|
||||
.TP
|
||||
.BI "getdnattrs " OBJECT " " ATTRNAME
|
||||
.TP
|
||||
.BI "addattr " OBJECT " " ATTRNAME " " VALUE
|
||||
.TP
|
||||
.BI "setattr " OBJECT " " ATTRNAME " " VALUE
|
||||
.TP
|
||||
.BI "addobject " OBJECT " " CLASS " \fR[attr1=value1 attr2=...]\fP"
|
||||
.TP
|
||||
.BI "delobject " OBJECT " \fR[\fP " true " \fR|\fP " false " \fR]\fP"
|
||||
.TP
|
||||
.BI "listobjects " OBJECT
|
||||
.TP
|
||||
.BI "setpassword " OBJECT " \fR[\fP " PASSWORD " \fR|\fP \-f " PWFILE " \fR]\fP"
|
||||
.TP
|
||||
.BI "verifypassword " OBJECT " " PASSWORD
|
||||
.TP
|
||||
.BI "isobject " OBJECT
|
||||
.TP
|
||||
.BI "defattr " ATTRNAME " " ASN1 " \fR[opt1=val1 opt2=...]\fP"
|
||||
.TP
|
||||
.BI "defclass " CLASSNAME " " ASN1 " \fR[opt1=val1 opt2=...]\fP"
|
||||
.TP
|
||||
.BI "defclassattr " CLASSNAME " " ATTRNAME
|
||||
.TP
|
||||
.BI "delattrdef " ATTRNAME
|
||||
.TP
|
||||
.BI "delclassdef " CLASSNAME
|
||||
.TP
|
||||
.BI "grantobj " OBJECT " " TRUSTEE " \fR[opt=val1 opt2=...]\fP"
|
||||
.TP
|
||||
.BI "grantattr " OBJECT " " ATTRNAME " " TRUSTEE " \fR[opt1=val1 opt2=...]\fP"
|
||||
.TP
|
||||
.BI "gethostipaddr "
|
||||
.SH "AUTHOR"
|
||||
This man page was written by Jonny Lamb <jonnylamb@jonnylamb.com>.
|
||||
.SH "SEE ALSO"
|
||||
bongo-setup(1), bongo-admin(1)
|
||||
Reference in New Issue
Block a user