[pmg-devel] [PATCH pmg-docs] add documentation for RAR support

[Aaron Lauterer]

Two small things from my side.

On 6/10/20 4:08 PM, Stoiko Ivanov wrote:
> While clamav and our stack do support handling RAR archives, both need
> packages from `non-free` installed in order to work.
> 
> Adding the 2 packages to the appropriate places would still
> require a reference to the sources.list entry of how to get the `non-free`
> archive area enabled and that way we can reference one place to answer how
> to enable RAR support
> 
> Signed-off-by: Stoiko Ivanov <s.ivanov at proxmox.com>
> ---
> Sending this, since looking for the exact package names cost me a while and it
> was the third time this question came up in our forums - thanks to Dominik
> for insistently suggesting the patch!
> 
>   asciidoc/asciidoc-pmg.conf |  1 +
>   pmg-installation.adoc      | 22 ++++++++++++++++++++++
>   2 files changed, 23 insertions(+)
> 
> diff --git a/asciidoc/asciidoc-pmg.conf b/asciidoc/asciidoc-pmg.conf
> index eb3e8b7..d10debf 100644
> --- a/asciidoc/asciidoc-pmg.conf
> +++ b/asciidoc/asciidoc-pmg.conf
> @@ -18,6 +18,7 @@ postfix_beforequeue=http://www.postfix.org/SMTPD_PROXY_README.html[Postfix Befor
>   systemd=https://www.freedesktop.org/wiki/Software/systemd/[systemd]
>   clamav=https://www.clamav.net[ClamAV(R)]
>   debian=https://www.debian.org[Debian]
> +debian_nonfree_archive_area=https://www.debian.org/doc/debian-policy/ch-archive#the-non-free-archive-area[Debian's non-free archive area]
>   tts=http://www.template-toolkit.org[Template Toolkit]
>   dkim_rfc=https://tools.ietf.org/html/rfc6376[RFC 6376]
>   ifndef::docinfo1[]
> diff --git a/pmg-installation.adoc b/pmg-installation.adoc
> index 5887fd2..6997913 100644
> --- a/pmg-installation.adoc
> +++ b/pmg-installation.adoc
> @@ -403,3 +403,25 @@ f3f6c5a3a67baf38ad178e5ff1ee270c  /etc/apt/trusted.gpg.d/proxmox-ve-release-6.x.
>   ----
>   
>   
> +Other Repository Sources
> +~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Certain software cannot be made available in the `main` and `contrib`
> +areas of the {debian} archives, since it does not adhere to the The Debian

s/The //

It is written with a capital The on the Debian page but it's not part of 
the acronym and the Wiki page for it omits the `The` as well. If you 
want to keep the `The` I would remove the lower case `the` and put the 
whole `The Debian...` in some sort of highlighted format as otherwise 
the capital `The` is a bit confusing.

> +Free Software Guidelines (DFSG). These are distributed in the
> +{debian_nonfree_archive_area}. For {pmg} two packages from the `non-free` area
> +are needed in order to support the RAR archive format:
> +
> +* `p7zip-rar` for matching xref:pmg_mailfilter_what[Archive Objects] in the
> +  xref:chapter_mailfilter[Rule system]
> +
> +* `libclamunrar` for detecting viruses in RAR archives.
> +
> +.sources.list.entry for `non-free`

Maybe a small sentence like: "To enable the non-free repository add the 
following lines to the sources.list file:"?

> +----
> +deb http://deb.debian.org/debian/ buster non-free
> +deb http://security.debian.org/debian-security buster/updates non-free
> +deb http://deb.debian.org/debian/ buster-updates non-free
> +----
> +
> +
>