documentation: run pandoc against man page sources

Author: rizsotto

source/bear/man/bear.1

@@ -1,19 +1,5 @@
-.\" Automatically generated by Pandoc 2.19.2
+.\" Automatically generated by Pandoc 2.14.0.3
 .\"
-.\" 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 "BEAR" "1" "Jan 02, 2023" "Bear User Manuals" ""
 .hy
 .SH NAME
@@ -48,8 +34,7 @@ Enable verbose logging.
 .TP
 --output \f[I]file\f[R]
 Specify output file.
-(Default file name provided.)
-The output is a JSON compilation database.
+(Default file name provided.) The output is a JSON compilation database.
 .TP
 --append
 Use previously generated output file and append the new entries to it.
@@ -65,44 +50,44 @@ The configuration file captures how the output should be formatted and
 which entries it shall contain.
 .TP
 --force-preload
-Force to use the dynamic linker method of \f[V]intercept\f[R] command.
+Force to use the dynamic linker method of \f[C]intercept\f[R] command.
 .TP
 --force-wrapper
-Force to use the compiler wrapper method of \f[V]intercept\f[R] command.
+Force to use the compiler wrapper method of \f[C]intercept\f[R] command.
 .SH COMMANDS
 .TP
-\f[V]bear-intercept(1)\f[R]
-Intercepts events that happend during the execution of the build
+\f[B]\f[CB]bear-intercept(1)\f[B]\f[R]
+Intercepts events that happened during the execution of the build
 command.
 .TP
-\f[V]bear-citnames(1)\f[R]
-Deduce the sematics of the commands captured by
-\f[V]bear-intercept(1)\f[R].
+\f[B]\f[CB]bear-citnames(1)\f[B]\f[R]
+Deduce the semantics of the commands captured by
+\f[C]bear-intercept(1)\f[R].
 .SH OUTPUT
 .PP
 The JSON compilation database definition changed over time.
 The current version of Bear generates entries where:
 .TP
-\f[V]directory\f[R]
+\f[B]\f[CB]directory\f[B]\f[R]
 has absolute path.
 .TP
-\f[V]file\f[R]
+\f[B]\f[CB]file\f[B]\f[R]
 has absolute path.
 .TP
-\f[V]output\f[R]
+\f[B]\f[CB]output\f[B]\f[R]
 has absolute path.
 .TP
-\f[V]arguments\f[R]
-used instead of \f[V]command\f[R] to avoid shell escaping problems.
-(Configuration can force to emit the \f[V]command\f[R] field.)
-The compiler as the first argument has absolute path.
+\f[B]\f[CB]arguments\f[B]\f[R]
+used instead of \f[C]command\f[R] to avoid shell escaping problems.
+(Configuration can force to emit the \f[C]command\f[R] field.) The
+compiler as the first argument has absolute path.
 Some non compilation related flags are filtered out from the final
 output.
 .SH CONFIG FILE
 .PP
-Read \f[V]citnames\f[R] man page for the content of this file.
-\f[V]bear\f[R] is not reading the content of this file, but passing the
-file name to \f[V]citnames\f[R].
+Read \f[C]bear-citnames(1)\f[R] man page for the content of this file.
+\f[C]bear\f[R] is not reading the content of this file, but passing the
+file name to \f[C]bear citnames\f[R] command.
 .SH EXIT STATUS
 .PP
 The exit status of the program is the exit status of the build command.
@@ -123,15 +108,16 @@ The other common cause for empty output is that the build has a
 \[lq]configure\[rq] step, which captures the compiler to build the
 project.
 In case of Bear is using the \f[I]wrapper\f[R] mode (read
-\f[V]intercept\f[R] man page), it needs to run the configure step with
-Bear too (and discard that output), before run the build with Bear.
+\f[C]bear-intercept(1)\f[R] man page), it needs to run the configure
+step with Bear too (and discard that output), before run the build with
+Bear.
 .PP
 There could be many reasons for any of these failures.
 It\[cq]s better to consult with the project wiki page for known
 problems, before open a bug report.
 .SH COPYRIGHT
 .PP
-Copyright (C) 2012-2022 by L\['a]szl\['o] Nagy
+Copyright (C) 2012-2023 by L\['a]szl\['o] Nagy
 <https://github.com/rizsotto/Bear>
 .SH AUTHORS
 L\['a]szl\['o] Nagy.

source/citnames/man/bear-citnames.1

@@ -1,19 +1,5 @@
-.\" Automatically generated by Pandoc 2.19.2
+.\" Automatically generated by Pandoc 2.14.0.3
 .\"
-.\" 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 "BEAR-CITNAMES" "1" "Jan 02, 2023" "Bear User Manuals" ""
 .hy
 .SH NAME
@@ -49,14 +35,14 @@ Enable verbose logging.
 .TP
 --input \f[I]file\f[R]
 Specify input file.
-(Default file name provided.)
-The input is a command execution list, with some extra information.
+(Default file name provided.) The input is a command execution list,
+with some extra information.
 The syntax is detailed in a separate section.
 .TP
 --output \f[I]file\f[R]
 Specify output file.
-(Default file name provided.)
-The output is currently a JSON compilation database.
+(Default file name provided.) The output is currently a JSON compilation
+database.
 .TP
 --append
 Use previously generated output file and append the new entries to it.
@@ -70,8 +56,8 @@ entries.
 Allow the program to verify file location checks on the current machine
 it runs.
 (Default value provided.
-Run help to query it.)
-This is important if the execution list is not from the current host.
+Run help to query it.) This is important if the execution list is not
+from the current host.
 .TP
 --config \f[I]file\f[R]
 Specify a configuration file.
@@ -86,22 +72,22 @@ it recognized at all.
 .SH OBSERVABILITY
 .PP
 Any insight about the command recognition logic can be observed with
-\f[V]--verbose\f[R] flag on the standard error.
+\f[C]--verbose\f[R] flag on the standard error.
 Otherwise, the command is silent.
 .SH INPUT FILE
 .PP
 It\[cq]s a JSON file, with the command execution history.
 (Plus some metadata, that is useful for debugging the application which
-was produced it.)
-This file can be produced by the \f[V]bear intercept\f[R] command, which
-records the process executions of a build.
+was produced it.) This file can be produced by the
+\f[C]bear intercept\f[R] command, which records the process executions
+of a build.
 .PP
 Read more about the syntax of the file in the
-\f[V]bear-intercept(1)\f[R] man page.
+\f[C]bear-intercept(1)\f[R] man page.
 .SH OUTPUT FILE
 .PP
 Currently, the only output format is the JSON compilation database.
-Read more about the syntax of that in the \f[V]bear(1)\f[R] man page.
+Read more about the syntax of that in the \f[C]bear(1)\f[R] man page.
 .SH CONFIG FILE
 .PP
 The config file influences the command recognition (by the section
@@ -110,7 +96,7 @@ The config file influences the command recognition (by the section
 .PP
 The config file is optional.
 The program will use default values, which can be dumped with the
-\f[V]--verbose\f[R] flags.
+\f[C]--verbose\f[R] flags.
 .PP
 Some parts of the file has overlap with the command line arguments.
 If both present the command line argument overrides the config file
@@ -133,7 +119,8 @@ values.
     \[dq]content\[dq]: {
       \[dq]include_only_existing_source\[dq]: true,
       \[dq]paths_to_include\[dq]: [],
-      \[dq]paths_to_exclude\[dq]: []
+      \[dq]paths_to_exclude\[dq]: [],
+      \[dq]duplicate_filter_fields\[dq]: \[dq]file_output\[dq]
     },
     \[dq]format\[dq]: {
       \[dq]command_as_array\[dq]: true,
@@ -144,46 +131,50 @@ values.
 \f[R]
 .fi
 .TP
-\f[V]compilation.compilers_to_recognize\f[R]
+\f[B]\f[CB]compilation.compilers_to_recognize\f[B]\f[R]
 where compiler can be specified, which are not yet recognized by
 default.
-The \f[V]executable\f[R] is an absolute path to the compiler.
-The \f[V]flags_to_add\f[R] is an optional attribute, which contains
+The \f[C]executable\f[R] is an absolute path to the compiler.
+The \f[C]flags_to_add\f[R] is an optional attribute, which contains
 flags which will append to the final output.
 (It\[cq]s a good candidate to use this for adding OpenMPI compiler
-wrapper flags from the \f[V]mpicc --showme:compile\f[R] output.)
-The \f[V]flags_to_remove\f[R] is an optional attribute, where the given
+wrapper flags from the \f[C]mpicc --showme:compile\f[R] output.) The
+\f[C]flags_to_remove\f[R] is an optional attribute, where the given
 flags will be removed for the final argument list.
 (The flags checked for equality only, no regex match.
 Flags with arguments are not good candidates to put here, because the
 removal logic is too simple for that.)
 .TP
-\f[V]compilation.compilers_to_exclude\f[R]
+\f[B]\f[CB]compilation.compilers_to_exclude\f[B]\f[R]
 this is an optional list of executables (with absolute path) which needs
 to be removed from the output.
 .TP
-\f[V]output.content\f[R]
-The \f[V]paths_to_include\f[R] and \f[V]paths_to_exclude\f[R] are for
+\f[B]\f[CB]output.content\f[B]\f[R]
+The \f[C]paths_to_include\f[R] and \f[C]paths_to_exclude\f[R] are for
 filter out entries from these directories.
 (Directory names can be absolute paths or relative to the current
-working directory if the \f[V]--run-checks\f[R] flag passed.)
-The \f[V]include_only_existing_source\f[R] allows or disables file check
-for the output.
-The \f[V]--run-checks\f[R] flag overrides this config value.
+working directory if the \f[C]--run-checks\f[R] flag passed.) The
+\f[C]include_only_existing_source\f[R] allows or disables file check for
+the output.
+The \f[C]--run-checks\f[R] flag overrides this config value.
+The \f[C]duplicate_filter_fields\f[R] select the method how duplicate
+entries are detected in the output.
+The possible values for this field are: \f[C]all\f[R], \f[C]file\f[R]
+and \f[C]file_output\f[R].
 .TP
-\f[V]output.format\f[R]
-The \f[V]command_as_array\f[R] controls which command field is emitted
+\f[B]\f[CB]output.format\f[B]\f[R]
+The \f[C]command_as_array\f[R] controls which command field is emitted
 in the output.
-True produces \f[V]arguments\f[R], false produces \f[V]command\f[R]
+True produces \f[C]arguments\f[R], false produces \f[C]command\f[R]
 field.
-The \f[V]drop_output_field\f[R] will disable the \f[V]output\f[R] field
+The \f[C]drop_output_field\f[R] will disable the \f[C]output\f[R] field
 from the output.
 .SH SEE ALSO
 .PP
-\f[V]bear(1)\f[R], \f[V]bear-intercept(1)\f[R]
+\f[C]bear(1)\f[R], \f[C]bear-intercept(1)\f[R]
 .SH COPYRIGHT
 .PP
-Copyright (C) 2012-2022 by L\['a]szl\['o] Nagy
+Copyright (C) 2012-2023 by L\['a]szl\['o] Nagy
 <https://github.com/rizsotto/Bear>
 .SH AUTHORS
 L\['a]szl\['o] Nagy.

source/intercept/man/bear-intercept.1

@@ -1,19 +1,5 @@
-.\" Automatically generated by Pandoc 2.19.2
+.\" Automatically generated by Pandoc 2.14.0.3
 .\"
-.\" 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 "BEAR-INTERCEPT" "1" "Sep 04, 2021" "Bear User Manuals" ""
 .hy
 .SH NAME
@@ -34,8 +20,8 @@ Depending on the interception mode the output might only contain a
 subset of the executed commands.
 Interception modes are:
 .IP \[bu] 2
-\f[I]preload\f[R] uses the \f[V]LD_PRELOAD\f[R] or
-\f[V]DYLD_INSERT_LIBRARIES\f[R] mechanisms provided by the dynamic
+\f[I]preload\f[R] uses the \f[C]LD_PRELOAD\f[R] or
+\f[C]DYLD_INSERT_LIBRARIES\f[R] mechanisms provided by the dynamic
 linker.
 The pre-loaded library hijacks the process execution calls, and executes
 a supervisor process, which reports the execution.
@@ -47,7 +33,7 @@ The wrapper sends execution report and calls the original program.
 The method fails when the build system is not flexible enough for
 interposing build tools.
 .PP
-The reports are collected by the \f[V]intercept\f[R] over a gRPC
+The reports are collected by the \f[C]intercept\f[R] over a gRPC
 interface, and written into an output file.
 .SH OPTIONS
 .TP
@@ -62,8 +48,8 @@ Enable verbose logging.
 .TP
 --output \f[I]file\f[R]
 Specify output file.
-(Default file name provided.)
-The output is a command execution list, with some extra information.
+(Default file name provided.) The output is a command execution list,
+with some extra information.
 The syntax is detailed in a separate section.
 .TP
 --force-preload
@@ -74,11 +60,11 @@ Force to use the wrapper method to intercept the children processes.
 .SH EXIT STATUS
 .PP
 The exit status of the program is the exit status of the build command.
-Except when the program itself crashes, then it sets to non zero.
+Except when the program itself crashes, then it sets to non-zero.
 .SH OUTPUT FILE
 .PP
 The output file has JSON lines (https://jsonlines.org/) format, where
-each line terminated with \f[V]\[rs]n\f[R] line separator and each line
+each line terminated with \f[C]\[rs]n\f[R] line separator and each line
 is a JSON object.
 .PP
 The JSON objects are process execution events: process start, process
@@ -89,26 +75,26 @@ this project.)
 .PP
 The potential problems you can face with are: the build with and without
 the interception behaves differently (eg.: the build crash with the
-\f[V]intercept\f[R] tool, but succeed otherwise).
+intercept tool, but succeed otherwise).
 The output is empty, and it failed to intercept the children process
 execution by the build command.
 .PP
 The most common cause for empty outputs is that the build command did
 not execute any commands.
 The reason for that could be, because incremental builds not running the
 compilers if everything is up-to-date.
-Remember, \f[V]intercept\f[R] does not understand the build file (eg.:
+Remember, this program does not understand the build file (eg.:
 makefile), but intercepts the executed commands.
 .PP
 There could be many reasons for any of these failures.
 It\[cq]s better to consult with the project wiki page for known
 problems, before open a bug report.
 .SH SEE ALSO
 .PP
-\f[V]bear(1)\f[R]
+\f[C]bear(1)\f[R]
 .SH COPYRIGHT
 .PP
-Copyright (C) 2012-2022 by L\['a]szl\['o] Nagy
+Copyright (C) 2012-2023 by L\['a]szl\['o] Nagy
 <https://github.com/rizsotto/Bear>
 .SH AUTHORS
 L\['a]szl\['o] Nagy.