Skip to content

Commit

Permalink
Updating man
Browse files Browse the repository at this point in the history
  • Loading branch information
Sympa authors authored and ikedas committed Jun 11, 2023
1 parent f47beaa commit dd19d24
Show file tree
Hide file tree
Showing 19 changed files with 39 additions and 36 deletions.
2 changes: 1 addition & 1 deletion man/Sympa-ConfDef.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ and each robot.

# SEE ALSO

[sympa.conf(5)](./sympa.conf.5.md), [robot.conf(5)](./robot.conf.5.md).
[sympa\_config(5)](./sympa_config.5.md).

# HISTORY

Expand Down
14 changes: 6 additions & 8 deletions man/Sympa-Config-Schema.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ release: '6.2.72'

# NAME

Sympa::ListDef - Definition of list configuration parameters
Sympa::Config::Schema - Definition of configuration parameters

# DESCRIPTION

This module keeps definition of configuration parameters for each list.
This module keeps definition of configuration parameters.

## Global variable

Expand All @@ -23,10 +23,10 @@ This module keeps definition of configuration parameters for each list.

- %pinfo

This hash COMPLETELY defines ALL list parameters.
It is then used to load, save, view, edit list config files.
This hash COMPLETELY defines ALL parameters.
It is then used to load, save, view, edit config files.

List parameters format accepts the following keywords :
A parameter definition accepts the following keywords:

- context

Expand Down Expand Up @@ -242,12 +242,10 @@ This module keeps definition of configuration parameters for each list.

# SEE ALSO

[list\_config(5)](./list_config.5.md),
[sympa\_config(5)](./sympa_config.5.md),
[Sympa::List::Config](./Sympa-List-Config.3.md),
[Sympa::ListOpt](./Sympa-ListOpt.3.md).

[sympa.conf(5)](./sympa.conf.5.md), [robot.conf(5)](./robot.conf.5.md).

# HISTORY

[Sympa::ListDef](./Sympa-ListDef.3.md) was separated from [List](https://metacpan.org/pod/List) module on Sympa 6.2.
Expand Down
2 changes: 1 addition & 1 deletion man/Sympa-DataSource-File.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ release: '6.2.72'

# NAME

Sympa::DataSource::file - Data source based on local file
Sympa::DataSource::File - Data source based on local file

# DESCRIPTION

Expand Down
2 changes: 1 addition & 1 deletion man/Sympa-Internals.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ To know details of each module, run:

- [Sympa::Config::Schema](./Sympa-Config-Schema.3.md)

Definition of list configuration parameters
Definition of configuration parameters

- [Sympa::Config\_XML](./Sympa-Config_XML.3.md)

Expand Down
2 changes: 1 addition & 1 deletion man/Sympa-ListDef.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This module keeps definition of configuration parameters for each list.

# SEE ALSO

[list\_config(5)](./list_config.5.md),
[sympa\_config(5)](./sympa_config.5.md),
[Sympa::List::Config](./Sympa-List-Config.3.md),
[Sympa::ListOpt](./Sympa-ListOpt.3.md).

Expand Down
6 changes: 3 additions & 3 deletions man/Sympa-Spindle-ToList.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@ filters recipients by topics (see also [Sympa::Spool::Topic](./Sympa-Spool-Topic
message tracking modes if necessary.
- Transforms message by each reception mode.
- Enables DMARC protection (according to
[`dmarc_protection`](./list_config.5.md#dmarc_protection)
[`dmarc_protection`](./sympa_config.5.md#dmarc_protection)
list configuration parameter),
message personalization (according to
[`merge_feature`](./list_config.5.md#merge_feature)
[`personalization_feature`](./sympa_config.5.md#personalization_feature)
list configuration parameter) and/or
re-encryption by S/MIME (if original message was encrypted).
- Alters envelope sender of the message to _list_`-owner` address.

Then stores message into outgoing spool (see [Sympa::Spool::Outgoing](./Sympa-Spool-Outgoing.3.md))
with classified packets of recipients.

This cass updates statistics information of the list (with digest delivery,
This class updates statistics information of the list (with digest delivery,
[Sympa::Spindle::ToOutgoing](./Sympa-Spindle-ToOutgoing.3.md) will update it).

# SEE ALSO
Expand Down
6 changes: 3 additions & 3 deletions man/Sympa-Spindle-TransformIncoming.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ if available.
- Adds `X-Sympa-Topic` header field, if any message topics
(see [Sympa::Spool::Topic](./Sympa-Spool-Topic.3.md)) are tagged for the message.
- Anonymizes message,
if [`anonymous_sender`](./list_config.5.md#anonymous_sender) list configuration
if [`anonymous_sender`](./sympa_config.5.md#anonymous_sender) list configuration
parameter is enabled.
- Adds custom subject tag to `Subject` field, if
[`custom_subject`](./list_config.5.md#custom_subject) list configuration
[`custom_subject`](./sympa_config.5.md#custom_subject) list configuration
parameter is available.
- Enables message tracking (see [Sympa::Tracking](./Sympa-Tracking.3.md)) if necessary.
- Removes header fields specified by
[`remove_headers`](./list_config.5.md#remove_headers).
[`remove_headers`](./sympa_config.5.md#remove_headers).

Then this class passes the message to the next stage of transformation.

Expand Down
8 changes: 4 additions & 4 deletions man/Sympa-Spindle-TransformOutgoing.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Transformation processes by this class are done in the following order:
- Executes `post_archive` hook of [message hooks](./Sympa-Message-Plugin.3.md)
if available.
- Adds / modifies `Reply-To` header field,
if [`reply_to_header`](./list_config.5.md#reply_to_header) list option is
if [`reply_to_header`](./sympa_config.5.md#reply_to_header) list option is
enabled.
- Adds / overwrites following header fields:
- `X-Loop`
Expand All @@ -28,15 +28,15 @@ enabled.
- `Sender`
- `X-no-archive`
- Adds header fields specified by
[`custom_header`](./list_config.5.md#custom_header) list configuration parameter,
[`custom_header`](./sympa_config.5.md#custom_header) list configuration parameter,
if any.
- Adds RFC 2919 `List-Id` field,
RFC 2369 fields (according to
[`rfc2369_header_fields`](./list_config.5.md#rfc2369_header_fields) list
[`rfc2369_header_fields`](./sympa_config.5.md#rfc2369_header_fields) list
configuration option) and RFC 5064 `Archived-At` field (if archiving is
enabled).
- Removes header fields specified by
[`remove_outgoing_headers`](./list_config.5.md#remove_outgoing_headers)
[`remove_outgoing_headers`](./sympa_config.5.md#remove_outgoing_headers)
list configuration parameter, if any.

Then this class passes the message to the last stage of transformation,
Expand Down
2 changes: 1 addition & 1 deletion man/archived.8.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,6 @@ See [https://github.com/sympa-community/sympa/issues](https://github.com/sympa-c

# SEE ALSO

[sympa\_msg(8)](./sympa_msg.8.md), [bounced(8)](./bounced.8.md), [mhonarc(1)](./mhonarc.1.md), [sympa.conf(5)](./sympa.conf.5.md).
[sympa\_msg(8)](./sympa_msg.8.md), [bounced(8)](./bounced.8.md), [mhonarc(1)](./mhonarc.1.md), [sympa\_config(5)](./sympa_config.5.md).

[Sympa::Spindle::ProcessArchive](./Sympa-Spindle-ProcessArchive.3.md).
4 changes: 2 additions & 2 deletions man/auth.conf.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -398,8 +398,8 @@ paragraph may also be used for `generic_sso`.
Note that Sympa will act as a CAS client to validate CAS tickets. During this
exchange, Sympa will check the CAS server X.509 certificate. Therefore you
should ensure that the certificate authority of the CAS server is known by
Sympa ; this should be configured through the [cafile](./sympa.conf.5.md#cafile)
or [capath](./sympa.conf.5.md#capath) `sympa.conf` configuration parameters.
Sympa ; this should be configured through the [cafile](./sympa_config.5.md#cafile)
or [`capath`](./sympa_config.5.md#capath) `sympa.conf` configuration parameter.

- `regexp`
- `negative_regexp`
Expand Down
2 changes: 1 addition & 1 deletion man/bounced.8.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,6 @@ See [https://github.com/sympa-community/sympa/issues](https://github.com/sympa-c

# SEE ALSO

[sympa\_msg(8)](./sympa_msg.8.md), [wwsympa(8)](./wwsympa.8.md), [mhonarc(1)](./mhonarc.1.md), [sympa.conf(5)](./sympa.conf.5.md).
[sympa\_msg(8)](./sympa_msg.8.md), [wwsympa(8)](./wwsympa.8.md), [mhonarc(1)](./mhonarc.1.md), [sympa\_config(5)](./sympa_config.5.md).

[Sympa::Spindle::ProcessBounce](./Sympa-Spindle-ProcessBounce.3.md).
3 changes: 2 additions & 1 deletion man/bulk.8.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ of `bulk.pl`.

# SEE ALSO

[sympa.conf(5)](./sympa.conf.5.md), [sympa\_msg(8)](./sympa_msg.8.md).
[sympa\_config(5)](./sympa_config.5.md),
[sympa\_msg(8)](./sympa_msg.8.md).

[Sympa::Spindle::ProcessOutgoing](./Sympa-Spindle-ProcessOutgoing.3.md).

Expand Down
7 changes: 4 additions & 3 deletions man/charset.conf.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ directory:

# cp $DEFAULTDIR/charset.conf $SYSCONFDIR/charset.conf

And set the `legacy_character_support_feature` parameter value in
[`sympa.conf`](./sympa.conf.5.md) to `on`.
And set the
[`legacy_character_support_feature`](./sympa_config.5.md#legacy_character_support_feature)
parameter value in `sympa.conf` to `on`.

## Note

Expand All @@ -41,7 +42,7 @@ during upgrade process.

# SEE ALSO

[sympa.conf(5)](./sympa.conf.5.md).
[sympa\_config(5)](./sympa_config.5.md).

# HISTORY

Expand Down
2 changes: 1 addition & 1 deletion man/ldap_alias_manager.conf.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ldap\_alias\_manager.conf - Configuration of LDAP alias management
`ldap_alias_manager.conf` is used by the [ldap\_alias\_manager(8)](./ldap_alias_manager.8.md);
it allows one to manage mail aliases in an LDAP directory.
To make sympa use the ldap\_alias\_manager.pl script, you should edit the
'alias\_manager' [sympa.conf(5)](./sympa.conf.5.md) parameter.
[`alias_manager`](./sympa_config.5.md#alias_manager) `sympa.conf` parameter.

Format of `ldap_alias_manager.conf` is as following:

Expand Down
2 changes: 1 addition & 1 deletion man/nrcpt_by_domain.conf.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ TBD.
# SEE ALSO

[bulk(8)](./bulk.8.md),
[sympa.conf(5)](./sympa.conf.5.md).
[sympa\_config(5)](./sympa_config.5.md).

# HISTORY

Expand Down
3 changes: 2 additions & 1 deletion man/sympa-upgrade-incoming.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ Following site configuration parameters in `--CONFIG--` are referred.

# SEE ALSO

[sympa.conf(5)](./sympa.conf.5.md), [Sympa::Message](./Sympa-Message.3.md).
[sympa\_config(5)](./sympa_config.5.md),
[Sympa::Message](./Sympa-Message.3.md).

# HISTORY

Expand Down
2 changes: 1 addition & 1 deletion man/sympa-upgrade-outgoing.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ robot configuration parameters in `robot.conf` are referred.

# SEE ALSO

[sympa.conf(5)](./sympa.conf.5.md),
[sympa\_config(5)](./sympa_config.5.md),
[Sympa::Message](./Sympa-Message.3.md),
[Sympa::Spool::Outgoing](./Sympa-Spool-Outgoing.3.md).

Expand Down
3 changes: 2 additions & 1 deletion man/sympa_automatic.8.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,8 @@ of `sympa_automatic.pl`.

# SEE ALSO

[sympa.conf(5)](./sympa.conf.5.md), [sympa\_msg(8)](./sympa_msg.8.md).
[sympa\_config(5)](./sympa_config.5.md),
[sympa\_msg(8)](./sympa_msg.8.md).

[Sympa::Spindle::ProcessAutomatic](./Sympa-Spindle-ProcessAutomatic.3.md).

Expand Down
3 changes: 2 additions & 1 deletion man/sympa_msg.8.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,8 @@ of `sympa_msg.pl`.

# SEE ALSO

[sympa.conf(5)](./sympa.conf.5.md), [sympa(1)](./sympa.1.md).
[sympa\_config(5)](./sympa_config.5.md),
[sympa(1)](./sympa.1.md).

[archived(8)](./archived.8.md), [bulk(8)](./bulk.8.md), [bounced(8)](./bounced.8.md), [sympa\_automatic(8)](./sympa_automatic.8.md),
[task\_manager(8)](./task_manager.8.md).
Expand Down

0 comments on commit dd19d24

Please sign in to comment.