Replace tabs by blanks in our sample configuration files.

This commit is contained in:
Peter Simons 2019-07-12 15:57:51 +02:00
parent 6a411a6fab
commit e8498b8f6a
3 changed files with 132 additions and 132 deletions

View File

@ -1,5 +1,5 @@
How to use the Petidomo 2.x mailing list server How to use the Petidomo mailing list server
*********************************************** *******************************************
Petidomo is an automatic mailing list server, which maintains mailing lists Petidomo is an automatic mailing list server, which maintains mailing lists
without any human interaction. The program understands a set of commands without any human interaction. The program understands a set of commands
@ -8,38 +8,38 @@ lists you are subscribed on. These commands will be explained in the
following paragraphs: following paragraphs:
SUBSCRIBE SUBSCRIBE
The "subscribe" command will add your address to a mailing list. The "subscribe" command will add your address to a mailing list.
Usually sending an e-mail to the server with only this word in the Usually sending an e-mail to the server with only this word in the
body of the mail will do the right thing for you. In case you want body of the mail will do the right thing for you. In case you want
to subscribe an address not equal to the one you are mailing from, to subscribe an address not equal to the one you are mailing from,
you can add this address as parameter to the command, like this: you can add this address as parameter to the command, like this:
subscribe user@site.domain.net subscribe user@site.domain.net
Please note that many list servers to do not allow to subscribe Please note that many list servers to do not allow to subscribe
other addresses than your own, though, because this feature can be other addresses than your own, though, because this feature can be
abused. abused.
UNSUBSCRIBE UNSUBSCRIBE
Syntax and usage of the "unsubscribe" command are the same as with Syntax and usage of the "unsubscribe" command are the same as with
the "subscribe" command, the purpose is a bit different though: the "subscribe" command, the purpose is a bit different though:
Sending this command to the server will remove your address from Sending this command to the server will remove your address from
the mailing list. the mailing list.
INDEX INDEX
The "index" command does not need any parameters. Sending it to the The "index" command does not need any parameters. Sending it to the
server will get you a list of available mailing lists on this server will get you a list of available mailing lists on this
server. This is useful in case you want to subscribe to a list but server. This is useful in case you want to subscribe to a list but
can't remember the exact name anymore. can't remember the exact name anymore.
HELP HELP
The "help" command will make the list server send you this file. The "help" command will make the list server send you this file.
HELP listname HELP listname
If you specify a parameter after the "help" command, the server If you specify a parameter after the "help" command, the server
will send you the description of this mailing list back. The will send you the description of this mailing list back. The
description usually contains the topic and purpose of the mailing description usually contains the topic and purpose of the mailing
list. list.
Commands must begin at the first column on each line in the mail, to Commands must begin at the first column on each line in the mail, to
be recognized. Lines which do not contain a command will be ignored. be recognized. Lines which do not contain a command will be ignored.

View File

@ -2,10 +2,10 @@
# The following types of mailing lists exists: # The following types of mailing lists exists:
# #
# open -- The list is open for all postings which are not rejected # open -- The list is open for all postings which are not rejected
# due to the access control mechanism. # due to the access control mechanism.
# closed -- Only subscribers are allowed to post. # closed -- Only subscribers are allowed to post.
# moderated -- Only postings which contain the correct posting # moderated -- Only postings which contain the correct posting
# password are allowed. # password are allowed.
# acknowledged -- Every attempt to post will be answered with # acknowledged -- Every attempt to post will be answered with
# a request for acknowledgment, asking the poster to # a request for acknowledgment, asking the poster to
# confirm. This prevents abuse and forgery. # confirm. This prevents abuse and forgery.
@ -13,30 +13,30 @@
# acknowledge his posting once, after that, he can post # acknowledge his posting once, after that, he can post
# as he wishes. # as he wishes.
# #
# The default, if this option is unset, is an open mailing list. # The default, if this option is unset, is an open mailing list.
ListType open ListType open
# TAG: SubscriptionType <public|admin|acknowledged> # TAG: SubscriptionType <public|admin|acknowledged>
# public -- Everybody can subscribe and unsubscribe. # public -- Everybody can subscribe and unsubscribe.
# admin -- Un-/subscription can only be done by the admin. # admin -- Un-/subscription can only be done by the admin.
# Authenticiation is done via password mechanism. # Authenticiation is done via password mechanism.
# acknowledged -- Anybody can un-/subscribe, but he has to # acknowledged -- Anybody can un-/subscribe, but he has to
# acknowledge the request sent to the address add to or # acknowledge the request sent to the address add to or
# deleted from the list. # deleted from the list.
# #
# The default, if this option is unset, is to allow public # The default, if this option is unset, is to allow public
# subscription and unsubscription. # subscription and unsubscription.
SubscriptionType public SubscriptionType public
# TAG: AllowMembersCommand <yes|no> # TAG: AllowMembersCommand <yes|no>
# Does the 'members' or 'who' command work for this mailing list, or # Does the 'members' or 'who' command work for this mailing list, or
# do you want to keep the addresses of the subscribers confidential? # do you want to keep the addresses of the subscribers confidential?
# Set this option to 'yes' to allow the 'members'-command, or set it # Set this option to 'yes' to allow the 'members'-command, or set it
# to 'no' to disallow it. # to 'no' to disallow it.
# #
# The default, if the option is unset, is NOT to allow the 'members'- # The default, if the option is unset, is NOT to allow the 'members'-
# command. # command.
AllowMembersCommand no AllowMembersCommand no
# TAG: Hostname <string> # TAG: Hostname <string>
# This entry specifies the fully qualified domain name, Petidomo # This entry specifies the fully qualified domain name, Petidomo
@ -51,41 +51,41 @@ AllowMembersCommand no
# Hosting''. # Hosting''.
# #
# If this option is unset, Petidomo will use the name that has # If this option is unset, Petidomo will use the name that has
# been specified in the master config file, ~petidomo/etc/petidomo.conf. # been specified in the master config file, ~petidomo/etc/petidomo.conf.
#Hostname host.domain.net #Hostname host.domain.net
# TAG: AdminPassword <string> # TAG: AdminPassword <string>
# This tag sets the master password, which authenticiates the # This tag sets the master password, which authenticiates the
# administrator of this mailing list. The administrator has # administrator of this mailing list. The administrator has
# special priviledes, such as deleting other users, overriding # special priviledes, such as deleting other users, overriding
# access control restrictions or un-/subscribing users to closed # access control restrictions or un-/subscribing users to closed
# mailing lists. Passwords are always case-insensitive. # mailing lists. Passwords are always case-insensitive.
# #
# Leave this entry blank, if you don't want to enable remote # Leave this entry blank, if you don't want to enable remote
# administration of the mailing list. This is not recommended, # administration of the mailing list. This is not recommended,
# though, because you will have to edit all files manually, # though, because you will have to edit all files manually,
# then. # then.
#AdminPassword "open sesame" #AdminPassword "open sesame"
# TAG: PostingPassword <string> # TAG: PostingPassword <string>
# The posting password must be specified when posting to closed # The posting password must be specified when posting to closed
# or moderated mailing lists, or the server will reject the # or moderated mailing lists, or the server will reject the
# article and forward it to the list owner. Passwords are always # article and forward it to the list owner. Passwords are always
# case-insensitive. # case-insensitive.
#PostingPassword "yeahyeah" #PostingPassword "yeahyeah"
# TAG: ReplyTo <address|none> # TAG: ReplyTo <address|none>
# This tag controls the 'Reply-To:' field, which Petidomo adds # This tag controls the 'Reply-To:' field, which Petidomo adds
# to posted articles before they are delivered. Using this # to posted articles before they are delivered. Using this
# option, you can force Petidomo to insert a 'Reply-To:' which # option, you can force Petidomo to insert a 'Reply-To:' which
# points to a certain address, or you can tell Petidomo to leave # points to a certain address, or you can tell Petidomo to leave
# 'Reply-To:' alone, by setting the parameter to "none". # 'Reply-To:' alone, by setting the parameter to "none".
# #
# If this option is unset, Petidomo will default to insert a # If this option is unset, Petidomo will default to insert a
# 'Reply-To:' point back to the mailing list, so that # 'Reply-To:' point back to the mailing list, so that
# subscribers can conveniently post simply by hitting the # subscribers can conveniently post simply by hitting the
# 'reply' function in their mail reader. # 'reply' function in their mail reader.
#ReplyTo none #ReplyTo none
# TAG: PostingFilter <string> # TAG: PostingFilter <string>
# If you specify a posting filter, this program or script will # If you specify a posting filter, this program or script will
@ -96,98 +96,98 @@ AllowMembersCommand no
# filter can be used to manipulate the headers for special # filter can be used to manipulate the headers for special
# purposes, for example. # purposes, for example.
# #
# If the filter program exits with a returncode not equal to 0 # If the filter program exits with a returncode not equal to 0
# (zero), Petidomo will not post the article and terminate. # (zero), Petidomo will not post the article and terminate.
#PostingFilter "/bin/cat" #PostingFilter "/bin/cat"
# TAG: Archive <string> # TAG: Archive <string>
# Petidomo has the ability to archive all articles that have been # Petidomo has the ability to archive all articles that have been
# posted to a mailing list. With this tag you can chose the path to # posted to a mailing list. With this tag you can chose the path to
# this archive. You have two options: You can specify a directory # this archive. You have two options: You can specify a directory
# name here, or a file name. If Petidomo finds a file name, it will # name here, or a file name. If Petidomo finds a file name, it will
# simply append the posted article to the file, one by one. If you # simply append the posted article to the file, one by one. If you
# provide the path of a directory, Petidomo will save each article in # provide the path of a directory, Petidomo will save each article in
# a seperate file into this directory. Paths without a leading slash # a seperate file into this directory. Paths without a leading slash
# ("/") are treated relative to the list's home directory, otherwise # ("/") are treated relative to the list's home directory, otherwise
# the path is absolute. # the path is absolute.
# #
# If this option is unset, no archives of the posted articles will be # If this option is unset, no archives of the posted articles will be
# kept. # kept.
#Archive "log" #Archive "log"
# TAG: IntroductionFile <string> # TAG: IntroductionFile <string>
# This entry sets the path to the introduction file, which # This entry sets the path to the introduction file, which
# Petidomo will send to every new subscriber. If the path is not # Petidomo will send to every new subscriber. If the path is not
# absolute -- not beginning with a '/' character, that is --, it # absolute -- not beginning with a '/' character, that is --, it
# will be interpreted relative to the directory where this # will be interpreted relative to the directory where this
# config file has been found. # config file has been found.
# #
# If this option has not been set, the default value is # If this option has not been set, the default value is
# "introduction". # "introduction".
#IntroductionFile introduction #IntroductionFile introduction
# TAG: DescriptionFile <string> # TAG: DescriptionFile <string>
# This entry sets the path to the description file, which # This entry sets the path to the description file, which
# Petidomo will send back to a "help listname" command. If the # Petidomo will send back to a "help listname" command. If the
# path is not absolute -- not beginning with a '/' character, # path is not absolute -- not beginning with a '/' character,
# that is --, it will be interpreted relative to the directory # that is --, it will be interpreted relative to the directory
# where this config file has been found. # where this config file has been found.
# #
# If this option has not been set, the default value is # If this option has not been set, the default value is
# "description". # "description".
#DescriptionFile description #DescriptionFile description
# TAG: ACLFile <string> # TAG: ACLFile <string>
# This entry sets the path to the ACL file, which Petidomo will # This entry sets the path to the ACL file, which Petidomo will
# use to check whether a posting to this list is allowed. If the # use to check whether a posting to this list is allowed. If the
# path is not absolute -- not beginning with a '/' character, # path is not absolute -- not beginning with a '/' character,
# that is --, it will be interpreted relative to the directory # that is --, it will be interpreted relative to the directory
# where this config file has been found. # where this config file has been found.
# #
# If this option has not been set, the default value is "acl". # If this option has not been set, the default value is "acl".
#ACLFile acl #ACLFile acl
# TAG: HeaderFile <string> # TAG: HeaderFile <string>
# This entry sets the path to the header file, which's contents # This entry sets the path to the header file, which's contents
# Petidomo will add to the header of every posting on this list. # Petidomo will add to the header of every posting on this list.
# If the path is not absolute -- not beginning with a '/' # If the path is not absolute -- not beginning with a '/'
# character, that is --, it will be interpreted relative to the # character, that is --, it will be interpreted relative to the
# directory where this config file has been found. # directory where this config file has been found.
# #
# If this option has not been set, the default value is # If this option has not been set, the default value is
# "header". # "header".
#HeaderFile header #HeaderFile header
# TAG: SignatureFile <string> # TAG: SignatureFile <string>
# This entry sets the path to the signature file, which's # This entry sets the path to the signature file, which's
# contents Petidomo will append to every posting on this list. # contents Petidomo will append to every posting on this list.
# If the path is not absolute -- not beginning with a '/' # If the path is not absolute -- not beginning with a '/'
# character, that is --, it will be interpreted relative to the # character, that is --, it will be interpreted relative to the
# directory where this config file has been found. # directory where this config file has been found.
# #
# If this option has not been set, the default value is # If this option has not been set, the default value is
# "signature". # "signature".
#SignatureFile signature #SignatureFile signature
# TAG: AddressFile <string> # TAG: AddressFile <string>
# This entry sets the path to the address database file, which # This entry sets the path to the address database file, which
# Petidomo uses to store the addresses of the list's # Petidomo uses to store the addresses of the list's
# subscribers. If the path is not absolute -- not beginning with # subscribers. If the path is not absolute -- not beginning with
# a '/' character, that is --, it will be interpreted relative # a '/' character, that is --, it will be interpreted relative
# to the directory where this config file has been found. # to the directory where this config file has been found.
# #
# If this option has not been set, the default value is # If this option has not been set, the default value is
# "list". # "list".
#AddressFile list #AddressFile list
# TAG: AcknowledgementFile <string> # TAG: AcknowledgementFile <string>
# This entry sets the path to the acknowledgement database file, # This entry sets the path to the acknowledgement database file,
# which Petidomo uses to store the addresses of posters who have # which Petidomo uses to store the addresses of posters who have
# verified their address by acknowledgement already. If the path # verified their address by acknowledgement already. If the path
# is not absolute -- not beginning with a '/' character, that is # is not absolute -- not beginning with a '/' character, that is
# --, it will be interpreted relative to the directory where # --, it will be interpreted relative to the directory where
# this config file has been found. # this config file has been found.
# #
# If this option has not been set, the default value is # If this option has not been set, the default value is
# "list". # "list".
#AcknowledgementFile ack #AcknowledgementFile ack

View File

@ -65,7 +65,7 @@
# #
# The default ListDirectory, assuming an installation prefix of # The default ListDirectory, assuming an installation prefix of
# "/usr/local", is "/usr/local/var/petidomo/lists". # "/usr/local", is "/usr/local/var/petidomo/lists".
#ListDirectory /usr/local/var/petidomo/lists #ListDirectory /usr/local/var/petidomo/lists
# TAG: AckQueueDirectory <string> # TAG: AckQueueDirectory <string>
# This entry sets the path to the directory, where Petidomo will # This entry sets the path to the directory, where Petidomo will