Skip to content

Commit

Permalink
chore(builder): bump pandoc to 3.2
Browse files Browse the repository at this point in the history
It also updates all man by generating them with the new pandoc version.
  • Loading branch information
geyslan committed Jun 7, 2024
1 parent 396cbd5 commit 2ac1f85
Show file tree
Hide file tree
Showing 21 changed files with 363 additions and 695 deletions.
2 changes: 1 addition & 1 deletion builder/Dockerfile.man
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ENV DEBCONF_NOWARNINGS="yes"
RUN apt-get update -y && \
apt-get install -y make wget

ARG PANDOC_VERSION="3.1.2"
ARG PANDOC_VERSION="3.2"
ARG PANDOC_DEB="pandoc-${PANDOC_VERSION}-1-amd64.deb"

RUN wget -q https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/${PANDOC_DEB} && \
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/flags/cache.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: TRACEE-CACHE
section: 1
header: Tracee Cache Flag Manual
date: 2023/10
date: 2024/06
...

## NAME
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/flags/capabilities.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: TRACEE-CAPABILITIES
section: 1
header: Tracee Capabilities Flag Manual
date: 2023/10
date: 2024/06
...

## NAME
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/flags/capture.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: TRACEE-CAPTURE
section: 1
header: Tracee Capture Flag Manual
date: 2023/10
date: 2024/06
...

## NAME
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/flags/config.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: TRACEE-CONFIG
section: 1
header: Tracee Config Flag Manual
date: 2023/10
date: 2024/06
...

## NAME
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/flags/containers.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: TRACEE-CRI
section: 1
header: Tracee CRI Flag Manual
date: 2023/10
date: 2024/06
...

## NAME
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/flags/events.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: TRACEE-EVENTS
section: 1
header: Tracee Events Flag Manual
date: 2024/05
date: 2024/06
...

## NAME
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/flags/log.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: TRACEE-LOG
section: 1
header: Tracee Log Flag Manual
date: 2023/10
date: 2024/06
...

## NAME
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/flags/output.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: TRACEE-OUTPUT
section: 1
header: Tracee Output Flag Manual
date: 2024/02
date: 2024/06
...

## NAME
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/flags/rego.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: TRACEE-REGO
section: 1
header: Tracee Rego Flag Manual
date: 2023/10
date: 2024/06
...

## NAME
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/flags/scope.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: TRACEE-SCOPE
section: 1
header: Tracee Scope Flag Manual
date: 2023/10
date: 2024/06
...

## NAME
Expand Down
67 changes: 22 additions & 45 deletions docs/man/cache.1
Original file line number Diff line number Diff line change
@@ -1,74 +1,51 @@
.\" Automatically generated by Pandoc 3.1.2
.\" Automatically generated by Pandoc 3.2
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "TRACEE-CACHE" "1" "2023/10" "" "Tracee Cache Flag Manual"
.hy
.TH "TRACEE\-CACHE" "1" "2024/06" "" "Tracee Cache Flag Manual"
.SS NAME
.PP
tracee \f[B]--cache\f[R] - Select different cache types for the event
tracee \f[B]\-\-cache\f[R] \- Select different cache types for the event
pipeline queueing
.SS SYNOPSIS
.PP
tracee \f[B]--cache\f[R] [none|cache-type=<type>] [\f[B]--cache\f[R]
mem-cache-size=<size>]
tracee \f[B]\-\-cache\f[R] [none|cache\-type=<type>]
[\f[B]\-\-cache\f[R] mem\-cache\-size=<size>]
.SS DESCRIPTION
.PP
The \f[B]--cache\f[R] flag allows you to select different cache types
The \f[B]\-\-cache\f[R] flag allows you to select different cache types
for the event pipeline queueing.
.PP
Possible options for \f[B]cache-type\f[R] are:
Possible options for \f[B]cache\-type\f[R] are:
.IP \[bu] 2
\f[B]none\f[R]: No event caching in the pipeline (default) - similar to
\f[B]--cache none\f[R].
\f[B]none\f[R]: No event caching in the pipeline (default) \- similar to
\f[B]\-\-cache none\f[R].
.IP \[bu] 2
\f[B]mem\f[R]: Enables caching events in memory.
.PP
If \f[B]cache-type=mem\f[R] is chosen, you can also set the memory cache
size in megabytes (MB) using the \f[B]mem-cache-size\f[R] option.
This option only works when \f[B]cache-type=mem\f[R].
If \f[B]cache\-type=mem\f[R] is chosen, you can also set the memory
cache size in megabytes (MB) using the \f[B]mem\-cache\-size\f[R]
option.
This option only works when \f[B]cache\-type=mem\f[R].
.SS EXAMPLES
.IP \[bu] 2
To cache events in memory using the default values, use the following
flag:
.RS 2
.IP
.nf
\f[C]
--cache cache-type=mem
\f[R]
.fi
.EX
\-\-cache cache\-type=mem
.EE
.RE
.IP \[bu] 2
To cache events in memory and set the memory cache size to 1024 MB, use
the following flag:
.RS 2
.IP
.nf
\f[C]
--cache cache-type=mem --cache mem-cache-size=1024
\f[R]
.fi
.EX
\-\-cache cache\-type=mem \-\-cache mem\-cache\-size=1024
.EE
.RE
.IP \[bu] 2
To disable event caching in the pipeline, use the following flag:
.RS 2
.IP
.nf
\f[C]
--cache none
\f[R]
.fi
.EX
\-\-cache none
.EE
.RE
60 changes: 18 additions & 42 deletions docs/man/capabilities.1
Original file line number Diff line number Diff line change
@@ -1,35 +1,17 @@
.\" Automatically generated by Pandoc 3.1.2
.\" Automatically generated by Pandoc 3.2
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "TRACEE-CAPABILITIES" "1" "2023/10" "" "Tracee Capabilities Flag Manual"
.hy
.TH "TRACEE\-CAPABILITIES" "1" "2024/06" "" "Tracee Capabilities Flag Manual"
.SS NAME
.PP
tracee \f[B]--capabilities\f[R] - Opt out from dropping capabilities by
default or set specific ones
tracee \f[B]\-\-capabilities\f[R] \- Opt out from dropping capabilities
by default or set specific ones
.SS SYNOPSIS
.PP
tracee \f[B]--capabilities\f[R] [<bypass=[true|false]> |
tracee \f[B]\-\-capabilities\f[R] [<bypass=[true|false]> |
<add=cap1(,cap2\&...)> | <drop=cap1(,cap2\&...)>] \&...
[\f[B]--capabilities\f[R] [<add=cap1(,cap2\&...)> |
[\f[B]\-\-capabilities\f[R] [<add=cap1(,cap2\&...)> |
<drop=cap1(,cap2\&...)>] \&...]
.SS DESCRIPTION
.PP
The \f[B]--capabilities\f[R] flag allows you to control the dropping of
capabilities during execution time or set specific capabilities.
The \f[B]\-\-capabilities\f[R] flag allows you to control the dropping
of capabilities during execution time or set specific capabilities.
.PP
Possible options:
.IP \[bu] 2
Expand All @@ -49,39 +31,33 @@ You can specify multiple capability names separated by commas.
Please note that the available capabilities will depend on the running
system.
For the list of capabilities available on your system, see the
\f[B]list-caps\f[R] command.
\f[B]list\-caps\f[R] command.
.SS EXAMPLES
.IP \[bu] 2
To keep all capabilities during execution time, use the following flag:
.RS 2
.IP
.nf
\f[C]
--capabilities bypass=true
\f[R]
.fi
.EX
\-\-capabilities bypass=true
.EE
.RE
.IP \[bu] 2
To add specific capabilities (e.g., cap_kill and cap_syslog) to the
\[lq]required\[rq] capabilities ring, use the following flag:
.RS 2
.IP
.nf
\f[C]
--capabilities add=cap_kill,cap_syslog
\f[R]
.fi
.EX
\-\-capabilities add=cap_kill,cap_syslog
.EE
.RE
.IP \[bu] 2
To drop a specific capability (e.g., cap_chown) from the
\[lq]required\[rq] capabilities ring, use the following flag:
.RS 2
.IP
.nf
\f[C]
--capabilities drop=cap_chown
\f[R]
.fi
.EX
\-\-capabilities drop=cap_chown
.EE
.RE
.PP
Please refer to the documentation for more information on environment
Expand Down
Loading

0 comments on commit 2ac1f85

Please sign in to comment.