Updating man.

Author: Sympa authors

manual/man/Sympa-Internals.3.md

@@ -221,7 +221,7 @@ To know details of each module, run:
 
 - [Sympa::Scenario](./Sympa-Scenario.3.md)
 
-    TBD
+    Authorization scenarios
 
 - [Sympa::Spindle](./Sympa-Spindle.3.md)
 

manual/man/Sympa-Scenario.3.md

@@ -0,0 +1,167 @@
+---
+title: 'Sympa::Scenario(3)'
+---
+
+# NAME
+
+Sympa::Scenario - Authorization scenarios
+
+# SYNOPSIS
+
+    use Sympa::Scenario;
+    
+    my $scenario = Sympa::Scenario->new($list, 'send', name => 'private');
+    my $result = $scenario->authz('md5', {sender => $sender});
+
+# DESCRIPTION
+
+[Sympa::Scenario](./Sympa-Scenario.3.md) provides feature of scenarios which perform authorization
+on functions of Sympa software against users and clients.
+
+## Methods
+
+- new ( $that, $function, \[ name => $name \],
+\[ dont\_reload\_scenario => 1 \] )
+
+    _Constructor_.
+    Creates a new [Sympa::Scenario](./Sympa-Scenario.3.md) instance.
+
+    Parameters:
+
+    - $that
+
+        Context of scenario, list or domain
+        (note that scenario does not have site context).
+
+    - $function
+
+        Specifies scenario function.
+
+    - name => $name
+
+        Specifies scenario name.
+        If the name was not given, it is taken from list/domain configuration.
+        See ["Scenarios"](#scenarios) for details.
+
+    - dont\_reload\_scenario => 1
+
+        If set, won't check if scenario files were updated.
+
+    Returns:
+
+    A new [Sympa::Scenario](./Sympa-Scenario.3.md) instance.
+
+- authz ( $auth\_method, \\%context,  \[ debug => 1\] )
+
+    _Instance method_.
+    Return the action to perform for 1 sender
+    using 1 auth method to perform 1 function.
+
+    Parameters:
+
+    - $auth\_method
+
+        'smtp', 'md5', 'pgp', 'smime' or 'dkim'.
+        Note that \`pgp\` has not been implemented.
+
+    - \\%context
+
+        A hashref containing information to evaluate scenario (scenario context).
+
+    - debug => 1
+
+        Adds keys in the returned hashref.
+
+    Returns:
+
+    A hashref containing following items.
+
+    - {action}
+
+        'do\_it', 'reject', 'request\_auth',
+        'owner', 'editor', 'editorkey' or 'listmaster'.
+
+    - {reason}
+
+        Defined if {action} is 'reject' and in case `reject(reason='...')`:
+        Key for template authorization\_reject.tt2.
+
+    - {tt2}
+
+        Defined if {action} is 'reject' and in case `reject(tt2='...')` or
+        `reject('...tt2')`:
+        Mail template name to be sent back to request sender.
+
+    - {condition}
+
+        The checked condition (defined if debug is set).
+
+    - {auth\_method}
+
+        The checked auth\_method (defined if debug is set).
+
+- get\_current\_title ( )
+
+    _Instance method_.
+    Gets the title of the scenarioin the current language context.
+
+- is\_purely\_closed ( )
+
+    _Instance method_.
+    Returns true value if the scenario obviously returns "reject" action.
+
+- to\_string ( )
+
+    _Instance method_.
+    Returns source text of the scenario.
+
+## Functions
+
+- get\_scenarios ( $that, $function )
+
+    _Function_.
+    Gets all scenarios beloging to context $that and function $function.
+
+- request\_action ( $that, $function, $auth\_method, \\%context,
+\[ name => $name \], \[ dont\_reload\_scenario => 1 \], \[ debug => 1\] )
+
+    _Function_. Obsoleted on Sympa 6.2.42. Use authz() method instead.
+
+## Attributes
+
+Instance of [Sympa::Scenario](./Sympa-Scenario.3.md) has these attributes:
+
+- {context}
+
+    Context given by new().
+
+- {function}
+
+    Name of function.
+
+- {name}
+
+    Scenario name.
+
+- {file\_path}
+
+    Full path of scenario file.
+
+## Scenarios
+
+A scenario file is named as _`function`_`.`_`name`_,
+where _`function`_ is one of predefined function names, and
+_`name`_ distinguishes policy.
+
+If new() is called without `name` option, it is taken from configuration
+parameter of context. Some functions don't have corresponding configuration
+parameter and `name` options for them are mandatory.
+
+# SEE ALSO
+
+[sympa\_scenario(5)](./sympa_scenario.5.md).
+
+# HISTORY
+
+authz() method obsoleting request\_action() function introduced on
+Sympa 6.2.41b.

manual/man/Sympa-Template.3.md

@@ -83,10 +83,6 @@ Instance of [Sympa::Template](./Sympa-Template.3.md) may have following attribut
     _Read only_.
     Error occurred at the last execution of parse, or `undef`.
 
-- {plugins}
-
-    TBD.
-
 - {subdir}, {lang}, {lang\_only}
 
     TBD.

manual/man/Sympa-WWW-Session.3.md

@@ -146,12 +146,12 @@ Session store is used to keep users' personal data.
 - decrypt\_session\_id ( )
 
     _Function_.
-    TBD.
+    Deprecated.
 
 - encrypt\_session\_id ( )
 
     _Function_.
-    TBD.
+    Deprecated.
 
 - list\_sessions ( )
 

manual/man/list_config.5.md

@@ -2245,60 +2245,6 @@ Time ranges when inclusion is not allowed
 
     None.
 
-### `include_voot_group`
-
-VOOT group inclusion
-
-- Multiple occurrences allowed
-
-#### `include_voot_group.name`
-
-short name for this source
-
-- Format:
-
-    /`.+`/
-
-- Default:
-
-    None.
-
-#### `include_voot_group.user`
-
-user
-
-- Format:
-
-    /`\S+`/
-
-- Default:
-
-    None, _mandatory_.
-
-#### `include_voot_group.provider`
-
-provider
-
-- Format:
-
-    /`\S+`/
-
-- Default:
-
-    None, _mandatory_.
-
-#### `include_voot_group.group`
-
-group
-
-- Format:
-
-    /`\S+`/
-
-- Default:
-
-    None, _mandatory_.
-
 ### `ttl`
 
 Inclusions timeout

manual/man/sympa.conf.5.md

@@ -2887,6 +2887,20 @@ Format of values is a string without spaces including "y" for years, "m" for mon
 
     None.
 
+#### `shared_feature`
+
+Enable shared repository
+
+- Default:
+
+    `off`
+
+- Overrides:
+
+    Virtual domain
+
+If set to "on", list owners can open shared repository.
+
 #### `default_shared_quota`
 
 Default disk quota for shared repository
@@ -3199,7 +3213,7 @@ Quiet subscriptions policy
 
     None.
 
-Global policy for quiet subscriptions: "on" means that subscriptions will never send a notice to the subscriber, "off" will enforce a notice sending, "optional" (default) let use the list policy.
+Global policy for quiet subscriptions: "on" means that subscriptions will never send a notice to the subscriber, "off" will enforce a notice sending, and "optional" (default) allows the use of the list policy.
 
 ## S/MIME and TLS
 
@@ -3803,16 +3817,6 @@ Default timeout between two action-triggered synchronizations of list members wi
 
     None.
 
-#### `voot_feature`
-
-- Default:
-
-    `off`
-
-- Overrides:
-
-    None.
-
 #### `edit_list`
 
 - Default:
@@ -3873,7 +3877,7 @@ EXPERIMENTAL! Allow users to delete their account. If enabled, shows a "delete m
 
     None.
 
-Account deletion usubscribe the users from his/her lists and remove him/her from lists ownership. Only usable by users using internal authentication (i.e. no LDAP, no SSO…). See https://github.com/sympa-community/sympa/issues/300 for details
+Account deletion unsubscribes the users from his/her lists and removes him/her from lists ownership. It is only available to users using internal authentication (i.e. no LDAP, no SSO...). See https://github.com/sympa-community/sympa/issues/300 for details
 
 # FILES