neulab/tldr huggingface dataset:
--report-signal-unlocked=<yes|no> [default: yes] Whether to report calls to pthread_cond_signal and pthread_cond_broadcast where the mutex associated with the signal through pthread_cond_wait or pthread_cond_timed_waitis not locked at the time the signal is sent. Sending a signal without holding a lock on the associated mutex is a common programming error which can cause subtle race conditions and unpredictable behavior. There exist some uncommon synchronization patterns however where it is safe to send a signal without holding a lock on the associated mutex.
--segment-merging=<yes|no> [default: yes] Controls segment merging. Segment merging is an algorithm to limit memory usage of the data race detection algorithm. Disabling segment merging may improve the accuracy of the so-called 'other segments' displayed in race reports but can also trigger an out of memory error.
--segment-merging-interval=<n> [default: 10] Perform segment merging only after the specified number of new segments have been created. This is an advanced configuration option that allows one to choose whether to minimize DRD's memory usage by choosing a low value or to let DRD run faster by choosing a slightly higher value. The optimal value for this parameter depends on the program being analyzed. The default value works well for most programs.
--shared-threshold=<n> [default: off] Print an error message if a reader lock has been held longer than the specified time (in milliseconds). This option enables the detection of lock contention.
--show-confl-seg=<yes|no> [default: yes] Show conflicting segments in race reports. Since this information can help to find the cause of a data race, this option is enabled by default. Disabling this option makes the output of DRD more compact.
--show-stack-usage=<yes|no> [default: no] Print stack usage at thread exit time. When a program creates a large number of threads it becomes important to limit the amount of virtual memory allocated for thread stacks. This option makes it possible to observe how much stack memory has been used by each thread of the client program. Note: the DRD tool itself allocates some temporary data on the client thread stack. The space necessary for this temporary data must be allocated by the client program when it allocates stack memory, but is not included in stack usage reported by DRD.
--ignore-thread-creation=<yes|no> [default: no] Controls whether all activities during thread creation should be ignored. By default enabled only on Solaris. Solaris provides higher throughput, parallelism and scalability than other operating systems, at the cost of more fine-grained locking activity. This means for example that when a thread is created under glibc, just one big lock is used for all thread setup. Solaris libc uses several fine-grained locks and the creator thread resumes its activities as soon as possible, leaving for example stack and TLS setup sequence to the created thread. This situation confuses DRD as it assumes there is some false ordering in place between creator and created thread; and therefore many types of race conditions in the application would not be reported. To prevent such false ordering, this command line option is set to yes by default on Solaris. All activity (loads, stores, client requests) is therefore ignored during:
--trace-addr=<address> [default: none] Trace all load and store activity for the specified address. This option may be specified more than once.
--ptrace-addr=<address> [default: none] Trace all load and store activity for the specified address and keep doing that even after the memory at that address has been freed and reallocated.
--trace-alloc=<yes|no> [default: no] Trace all memory allocations and deallocations. May produce a huge amount of output.
--trace-barrier=<yes|no> [default: no] Trace all barrier activity.
--trace-cond=<yes|no> [default: no] Trace all condition variable activity.
--trace-fork-join=<yes|no> [default: no] Trace all thread creation and all thread termination events.
--trace-hb=<yes|no> [default: no] Trace execution of the ANNOTATE_HAPPENS_BEFORE(), ANNOTATE_HAPPENS_AFTER() and ANNOTATE_HAPPENS_DONE() client requests.
--trace-mutex=<yes|no> [default: no] Trace all mutex activity.
--trace-rwlock=<yes|no> [default: no] Trace all reader-writer lock activity.
--trace-semaphore=<yes|no> [default: no] Trace all semaphore activity.
--heap=<yes|no> [default: yes] Specifies whether heap profiling should be done.
--heap-admin=<size> [default: 8] If heap profiling is enabled, gives the number of administrative bytes per block to use. This should be an estimate of the average, since it may vary. For example, the allocator used by glibc on Linux requires somewhere between 4 to 15 bytes per block, depending on various factors. That allocator also requires admin space for freed blocks, but Massif cannot account for this.
--stacks=<yes|no> [default: no] Specifies whether stack profiling should be done. This option slows Massif down greatly, and so is off by default. Note that Massif assumes that the main stack has size zero at start-up. This is not true, but doing otherwise accurately is difficult. Furthermore, starting at zero better indicates the size of the part of the main stack that a user program actually has control over.
--pages-as-heap=<yes|no> [default: no] Tells Massif to profile memory at the page level rather than at the malloc'd block level. See above for details.
--depth=<number> [default: 30] Maximum depth of the allocation trees recorded for detailed snapshots. Increasing it will make Massif run somewhat more slowly, use more memory, and produce bigger output files.
--alloc-fn=<name> Functions specified with this option will be treated as though they were a heap allocation function such as malloc. This is useful for functions that are wrappers to malloc or new, which can fill up the allocation trees with uninteresting information. This option can be specified multiple times on the command line, to name multiple functions.
Note that the named function will only be treated this way if it is the top entry in a stack trace, or just below another function treated this way. For example, if you have a function malloc1 that wraps malloc, and malloc2 that wraps malloc1, just specifying --alloc-fn=malloc2 will have no effect. You need to specify --alloc-fn=malloc1 as well. This is a little inconvenient, but the reason is that checking for allocation functions is slow, and it saves a lot of time if Massif can stop looking through the stack trace entries as soon as it finds one that doesn't match rather than having to continue through all the entries.
Note that C++ names are demangled. Note also that overloaded C++ names must be written in full. Single quotes may be necessary to prevent the shell from breaking them up. For example:
--alloc-fn='operator new(unsigned, std::nothrow_t const&)'
--ignore-fn=<name> Any direct heap allocation (i.e. a call to malloc, new, etc, or a call to a function named by an --alloc-fn option) that occurs in a function specified by this option will be ignored. This is mostly useful for testing purposes. This option can be specified multiple times on the command line, to name multiple functions.
Any realloc of an ignored block will also be ignored, even if the realloc call does not occur in an ignored function. This avoids the possibility of negative heap sizes if ignored blocks are shrunk with realloc.
The rules for writing C++ function names are the same as for --alloc-fn above.
--threshold=<m.n> [default: 1.0] The significance threshold for heap allocations, as a percentage of total memory size. Allocation tree entries that account for less than this will be aggregated. Note that this should be specified in tandem with ms_print's option of the same name.
--peak-inaccuracy=<m.n> [default: 1.0] Massif does not necessarily record the actual global memory allocation peak; by default it records a peak only when the global memory allocation size exceeds the previous peak by at least 1.0%. This is because there can be many local allocation peaks along the way, and doing a detailed snapshot for every one would be expensive and wasteful, as all but one of them will be later discarded. This inaccuracy can be changed (even to 0.0%) via this option, but Massif will run drastically slower as the number approaches zero.
--time-unit=<i|ms|B> [default: i] The time unit used for the profiling. There are three possibilities: instructions executed (i), which is good for most cases; real (wallclock) time (ms, i.e. milliseconds), which is sometimes useful; and bytes allocated/deallocated on the heap and/or stack (B), which is useful for very short-run programs, and for testing purposes, because it is the most reproducible across different machines.
--detailed-freq=<n> [default: 10] Frequency of detailed snapshots. With --detailed-freq=1, every snapshot is detailed.
--max-snapshots=<n> [default: 100] The maximum number of snapshots recorded. If set to N, for all programs except very short-running ones, the final number of snapshots will be between N/2 and N.
--massif-out-file=<file> [default: massif.out.%p] Write the profile data to file rather than to the default output file, massif.out.<pid>. The %p and %q format specifiers can be used to embed the process ID and/or the contents of an environment variable in the name, as is the case for the core option --log-file.
--bb-out-file=<name> [default: bb.out.%p] This option selects the name of the basic block vector file. The %p and %q format specifiers can be used to embed the process ID and/or the contents of an environment variable in the name, as is the case for the core option --log-file.
--pc-out-file=<name> [default: pc.out.%p] This option selects the name of the PC file. This file holds program counter addresses and function name info for the various basic blocks. This can be used in conjunction with the basic block vector file to fast-forward via function names instead of just instruction counts. The %p and %q format specifiers can be used to embed the process ID and/or the contents of an environment variable in the name, as is the case for the core option --log-file.
--interval-size=<number> [default: 100000000] This option selects the size of the interval to use. The default is 100 million instructions, which is a commonly used value. Other sizes can be used; smaller intervals can help programs with finer-grained phases. However smaller interval size can lead to accuracy issues due to warm-up effects (When fast-forwarding the various architectural features will be un-initialized, and it will take some number of instructions before they "warm up" to the state a full simulation would be at without the fast-forwarding. Large interval sizes tend to mitigate this.)
--instr-count-only [default: no] This option tells the tool to only display instruction count totals, and to not generate the actual basic block vector file. This is useful for debugging, and for gathering instruction count info without generating the large basic block vector files.
--basic-counts=<no|yes> [default: yes] When enabled, Lackey prints the following statistics and information about the execution of the client program:
1. The number of calls to the function specified by the --fnname option (the default is main). If the program has had its symbols stripped, the count will always be zero.
2. The number of conditional branches encountered and the number and proportion of those taken.
3. The number of superblocks entered and completed by the program. Note that due to optimisations done by the JIT, this is not at all an accurate value.
4. The number of guest (x86, amd64, ppc, etc.) instructions and IR statements executed. IR is Valgrind's RISC-like intermediate representation via which all instrumentation is done.
5. Ratios between some of these counts.
6. The exit code of the client program.
--detailed-counts=<no|yes> [default: no] When enabled, Lackey prints a table containing counts of loads, stores and ALU operations, differentiated by their IR types. The IR types are identified by their IR name ("I1", "I8", ... "I128", "F32", "F64", and "V128").
--trace-mem=<no|yes> [default: no] When enabled, Lackey prints the size and address of almost every memory access made by the program. See the comments at the top of the file lackey/lk_main.c for details about the output format, how it works, and inaccuracies in the address trace. Note that this option produces immense amounts of output.
--trace-superblocks=<no|yes> [default: no] When enabled, Lackey prints out the address of every superblock (a single entry, multiple exit, linear chunk of code) executed by the program. This is primarily of interest to Valgrind developers. See the comments at the top of the file lackey/lk_main.c for details about the output format. Note that this option produces large amounts of output.
--fnname=<name> [default: main] Changes the function for which calls are counted when --basic-counts=yes is specified.
Valgrind supports the downloading of debuginfo files via debuginfod, an HTTP server for distributing ELF/DWARF debugging information. When a debuginfo file cannot be found locally, Valgrind is able to query debuginfod servers for the file using its build-id.
In order to use this feature debuginfod-find must be installed and $DEBUGINFOD_URLS must contain URLs of debuginfod servers. Valgrind does not support debuginfod-find verbose output that is normally enabled with $DEBUGINFOD_PROGRESS and $DEBUGINFOD_VERBOSE. These environment variables will be ignored.
For more information regarding debuginfod, see https://sourceware.org/elfutils/Debuginfod.html
cg_annotate(1), callgrind_annotate(1), callgrind_control(1), ms_print(1), $INSTALL/share/doc/valgrind/html/index.html or http://www.valgrind.org/docs/manual/index.html, Debugging your program using Valgrind's gdbserver and GDB[1] vgdb[2], Valgrind monitor commands[3], The Commentary[4], Scheduling and Multi-Thread Performance[5], Cachegrind: a cache and branch-prediction profiler[6]. Execution Trees[7]
See the AUTHORS file in the valgrind distribution for a comprehensive list of authors.
This manpage was written by Andres Roldan <aroldan@debian.org> and the Valgrind developers.
1. Debugging your program using Valgrind's gdbserver and GDB http://www.valgrind.org/docs/manual/manual-core-adv.html#manual-core-adv.gdbserver
2. vgdb http://www.valgrind.org/docs/manual/manual-core-adv.html#manual-core-adv.vgdb
3. Valgrind monitor commands http://www.valgrind.org/docs/manual/manual-core-adv.html#manual-core-adv.valgrind-monitor-commands
4. The Commentary http://www.valgrind.org/docs/manual/manual-core.html#manual-core.comment
5. Scheduling and Multi-Thread Performance http://www.valgrind.org/docs/manual/manual-core.html#manual-core.pthreads_perf_sched
6. Cachegrind: a cache and branch-prediction profiler http://www.valgrind.org/docs/manual/cg-manual.html
7. Execution Trees http://www.valgrind.org/docs/manual/manual-core.html#manual-core.xtree
gnucash - personal finance manager
gnucash [options] [ accounts.gnucash ]
GnuCash is a personal accounting package that allows you to record and track income, expenses, assets, and investments. It supports reconciliation, has substantial reporting capabilities, and is extensible using guile. It can import QIF data from Quicken(TM) and many other commercial accounting packages. It uses GTK+ and GNOME to provide an attractive user interface, and has extensive online help.
--version Show GnuCash version
--nofile Do not load the last file opened
--add-price-quotes FILE Add price quotes to the given data file. Note this option has been deprecated and will be removed in GnuCash 5.0. Instead use 'gnucash-cli --quotes get'.
--namespace=REGEXP Regular expression determining which namespace commodities will be retrieved.  This is only relevant for the --add-price-quotes option. And as with that option it is deprecated and will be removed in GnuCash 5.0. The same option can be passed to 'gnucash- cli --quotes get' to achieve the same result.
stl2gts(1)               GNU Triangulated Surface utils               stl2gts(1)
stl2gts - convert an STL file to GTS format.
stl2gts [OPTIONS] < input.stl > output.gts
This manual page documents briefly the stl2gts command.
-r, --revert Revert face normals.
-n, --nomerge Do not merge vertices.
-v, --verbose Display surface statistics.
-h, --help Display the help and exit.
stl2gts was written by Stephane Popinet <popinet@users.sourceforge.net>.
This manual page was written by Ruben Molina <rmolina@udea.edu.co>, for the Debian project (but may be used by others).
KPACKAGETOOL5(1)                KPackage Manager                KPACKAGETOOL5(1)
kpackagetool5 - Install, list, remove Plasma packages
kpackagetool5
[-v, --version] [-h, --help] [--hash  path] [-g, --global] [-t, --type  type] [-i, --install  path] [-s, --show  name] [-u, --upgrade  path] [-l, --list] [--list-types] [-r, --remove  name] [-p, --packageroot  path] [--generate-index]
kpackagetool5 is a command line tool to install, list, remove Plasma packages.
Displays version information.
Displays this help.
--hash  path
Generate a SHA1 hash for the package at “path”.
For install or remove, operates on packages installed for all users.
-t, --type  type
The type of package, corresponding to the service type of the package plugin, e.g.  KPackage/Generic, Plasma/Theme, Plasma/Wallpaper, Plasma/Applet, etc.
-i, --install  path
Install the package at “path”.
-s, --show  name
Show information of package “name”.
-u, --upgrade  path
Upgrade the package at “path”.
-l, --list
List installed packages.
--list-types
Lists all known Package types that can be installed.
-r, --remove  name
Remove the package named “name”.
-p, --packageroot  path
Absolute path to the package root. If not supplied, then the standard data directories for this Plasma session will be searched instead.
--generate-index  path
Recreate the plugin index. To be used in conjunction with either the option -t or -g. Recreates the index for the given type or package root. Operates in the user directory, unless -g is used.
More detailed user documentation is available from help:/plasma-desktop (either enter this URL into Konqueror, or run khelpcenter help:/plasma-desktop).
kpackagetool5 was written by Aaron Seigo <aseigo@kde.org>.
GROFF(1)                     General Commands Manual                    GROFF(1)
groff - front-end for the groff document formatting system
groff [-abcegijklpstzCEGNRSUVXZ] [-d cs] [-D arg] [-f fam] [-F dir] [-I dir] [-K arg] [-L arg] [-m name] [-M dir] [-n num] [-o list] [-P arg] [-r cn] [-T dev] [-w name] [-W name] [file ...]
groff -h groff --help
groff -v [option ...] groff --version [option ...]
This document describes the groff program, the main front-end for the groff document formatting system.  The groff program and macro suite is the implementation of a roff(7) system within the free software collection GNU ⟨http://www.gnu.org⟩.  The groff system has all features of the classical roff, but adds many extensions.
The groff program allows control of the whole groff system by command- line options.  This is a great simplification in comparison to the classical case (which uses pipes only).
The command line is parsed according to the usual GNU convention. Whitespace is permitted between a command-line option and its argument. Options can be grouped behind a single ‘-’ (minus character).  A filename of - (minus character) denotes the standard input.
As groff is a wrapper program for troff both programs share a set of options.  But the groff program has some additional, native options and gives a new meaning to some troff options.  On the other hand, not all troff options can be fed into groff.
Native groff Options The following options either do not exist for troff or are differently interpreted by groff.
-D arg Set default input encoding used by preconv to arg.  Implies -k.
-e     Preprocess with eqn.
-g     Preprocess with grn.
-G     Preprocess with grap.  Implies -p.
-h --help Print a help message.
-I dir This option may be used to specify a directory to search for files (both those on the command line and those named in .psbb and .so requests, and \X'ps: import' , \X'ps: file' and \X'pdf: pdfpic' escapes).  The current directory is always searched first.  This option may be specified more than once; the directories are searched in the order specified.  No directory search is performed for files specified using an absolute path.  This option implies the -s option.
-j     Preprocess with chem.  Implies -p.
-k     Preprocess with preconv.  This is run before any other preprocessor.  Please refer to preconv's manual page for its behaviour if no -K (or -D) option is specified.
-K arg Set input encoding used by preconv to arg.  Implies -k.
-l     Send the output to a spooler program for printing.  The command that should be used for this is specified by the print command in the device description file, see groff_font(5).  If this command is not present, the output is piped into the lpr(1) program by default.  See options -L and -X.
-L arg Pass arg to the spooler program.  Several arguments should be passed with a separate -L option each.  Note that groff does not prepend ‘-’ (a minus sign) to arg before passing it to the spooler program.
-N     Don't allow newlines within eqn delimiters.  This is the same as the -N option in eqn.
-p     Preprocess with pic.
-P -option -P -option -P arg Pass -option or -option arg to the postprocessor.  The option must be specified with the necessary preceding minus sign(s) ‘-’ or ‘--’ because groff does not prepend any dashes before passing it to the postprocessor.  For example, to pass a title to the gxditview postprocessor, the shell command
groff -X -P -title -P 'groff it' foo
groff -X -Z foo | gxditview -title 'groff it' -
-R     Preprocess with refer.  No mechanism is provided for passing arguments to refer because most refer options have equivalent language elements that can be specified within the document.  See refer(1) for more details.
-s     Preprocess with soelim.
-S     Safer mode.  Pass the -S option to pic and disable the following troff requests: .open, .opena, .pso, .sy, and .pi.  For security reasons, safer mode is enabled by default.
-t     Preprocess with tbl.
-T dev Set output device to dev.  For this device, troff generates the intermediate output; see groff_out(5).  Then groff calls a postprocessor to convert troff's intermediate output to its final format.  Real devices in groff are
dvi    TeX DVI format (postprocessor is grodvi).
html xhtml  HTML and XHTML output (preprocessors are soelim and pre-grohtml, postprocessor is post-grohtml).
lbp    Canon CAPSL printers (LBP-4 and LBP-8 series laser printers; postprocessor is grolbp).
lj4    HP LaserJet4 compatible (or other PCL5 compatible) printers (postprocessor is grolj4).
ps     PostScript output (postprocessor is grops).
pdf    Portable Document Format (PDF) output (postprocessor is gropdf).
For the following TTY output devices (postprocessor is always grotty), -T selects the output encoding:
ascii  7bit ASCII.
cp1047 Latin-1 character set for EBCDIC hosts.
latin1 ISO 8859-1.
utf8   Unicode character set in UTF-8 encoding.  This mode has the most useful fonts for TTY mode, so it is the best mode for TTY output.
The following arguments select gxditview as the ‘postprocessor’ (it is rather a viewing program):
X75    75dpi resolution, 10pt document base font.
X75-12 75dpi resolution, 12pt document base font.
X100   100dpi resolution, 10pt document base font.
X100-12 100dpi resolution, 12pt document base font.
The default device is ps.
-U     Unsafe mode.  Reverts to the (old) unsafe behaviour; see option -S.
-v --version Output version information of groff and of all programs that are run by it; that is, the given command line is parsed in the usual way, passing -v to all subprograms.
-V     Output the pipeline that would be run by groff (as a wrapper program) on the standard output, but do not execute it.  If given more than once, the commands are both printed on the standard error and run.
-X     Use gxditview instead of using the usual postprocessor to (pre)view a document.  The printing spooler behavior as outlined with options -l and -L is carried over to gxditview(1) by determining an argument for the -printCommand option of gxditview(1).  This sets the default Print action and the corresponding menu entry to that value.  -X only produces good results with -Tps, -TX75, -TX75-12, -TX100, and -TX100-12.  The default resolution for previewing -Tps output is 75dpi; this can be changed by passing the -resolution option to gxditview, for example
groff -X -P-resolution -P100 -man foo.1
-z     Suppress output generated by troff.  Only error messages are printed.
-Z     Do not automatically postprocess groff intermediate output in the usual manner.  This will cause the troff output to appear on standard output, replacing the usual postprocessor output; see groff_out(5).
Transparent Options The following options are transparently handed over to the formatter program troff that is called by groff subsequently.  These options are described in more detail in troff(1).
-a     ASCII approximation of output.
-b     Backtrace on error or warning.
-c     Disable color output.  Please consult the grotty(1) man page for more details.
-C     Enable compatibility mode.
-d cs -d name=s Define string.
-E     Disable troff error messages.
-f fam Set default font family.
-F dir Set path for device DESC files.
-i     Process standard input after the specified input files.
-m name Include macro file name.tmac (or tmac.name); see also groff_tmac(5).
-M dir Path for macro files.
-n num Number the first page num.
-o list Output only pages in list.
-r cn -r name=n Set number register.
-w name Enable warning name.  See troff(1) for names.
-W name disable warning name.  See troff(1) for names.
The groff system implements the infrastructure of classical roff; see roff(7) for a survey on how a roff system works in general.  Due to the front-end programs available within the groff system, using groff is much easier than classical roff.  This section gives an overview of the parts that constitute the groff system.  It complements roff(7) with groff- specific features.  This section can be regarded as a guide to the documentation around the groff system.
Paper Size The virtual paper size used by troff to format the input is controlled globally with the requests .po, .pl, and .ll.  See groff_tmac(5) for the ‘papersize’ macro package which provides a convenient interface.
The physical paper size, giving the actual dimensions of the paper sheets, is controlled by output devices like grops with the command-line options -p and -l.  See groff_font(5) and the man pages of the output devices for more details.  groff uses the command-line option -P to pass options to output devices; for example, the following selects A4 paper in landscape orientation for the PS device:
groff -Tps -P-pa4 -P-l ...
Front-ends The groff program is a wrapper around the troff(1) program.  It allows one to specify the preprocessors by command-line options and automatically runs the postprocessor that is appropriate for the selected device.  Doing so, the sometimes tedious piping mechanism of classical roff(7) can be avoided.
The grog(1) program can be used for guessing the correct groff command line to format a file.
The groffer(1) program is an all-around viewer for groff files and man pages.
Preprocessors The groff preprocessors are reimplementations of the classical preprocessors with moderate extensions.  The standard preprocessors distributed with the groff package are
eqn(1) for mathematical formulae,
grn(1) for including gremlin(1) pictures,
pic(1) for drawing diagrams,
chem(1) for chemical structure diagrams,
refer(1) for bibliographic references,
soelim(1) for including macro files from standard locations,
tbl(1) for tables.
A new preprocessor not available in classical troff is preconv(1) which converts various input encodings to something groff can understand.  It is always run first before any other preprocessor.
Besides these, there are some internal preprocessors that are automatically run with some devices.  These aren't visible to the user.
Macro Packages Macro packages can be included by option -m.  The groff system implements and extends all classical macro packages in a compatible way and adds some packages of its own.  Actually, the following macro packages come with groff:
man    The traditional man page format; see groff_man(7).  It can be specified on the command line as -man or -m man.
mandoc The general package for man pages; it automatically recognizes whether the documents uses the man or the mdoc format and branches to the corresponding macro package.  It can be specified on the command line as -mandoc or -m mandoc.
mdoc   The BSD-style man page format; see groff_mdoc(7).  It can be specified on the command line as -mdoc or -m mdoc.
me     The classical me document format; see groff_me(7).  It can be specified on the command line as -me or -m me.
mm     The classical mm document format; see groff_mm(7).  It can be specified on the command line as -mm or -m mm.
ms     The classical ms document format; see groff_ms(7).  It can be specified on the command line as -ms or -m ms.
www    HTML-like macros for inclusion in arbitrary groff documents; see groff_www(7).
Details on the naming of macro files and their placement can be found in groff_tmac(5); this man page also documents some other, minor auxiliary macro packages not mentioned here.
Programming Language General concepts common to all roff programming languages are described in roff(7).
The groff extensions to the classical troff language are documented in groff_diff(7).
An overview of language features, including all supported escapes and requests, can be found in groff(7).
Formatters The central roff formatter within the groff system is troff(1).  It provides the features of both the classical troff and nroff, as well as the groff extensions.  The command-line option -C switches troff into compatibility mode which tries to emulate classical roff as much as possible.
There is a shell script nroff(1) that emulates the behavior of classical nroff.  It tries to automatically select the proper output encoding, according to the current locale.
The formatter program generates intermediate output; see groff_out(7).
Devices In roff, the output targets are called devices.  A device can be a piece of hardware, e.g., a printer, or a software file format.  A device is specified by the option -T.  The groff devices are as follows.
ascii  Text output using the ascii(7) character set.
cp1047 Text output using the EBCDIC code page IBM cp1047 (e.g., OS/390 Unix).
dvi    TeX DVI format.
html   HTML output.
latin1 Text output using the ISO Latin-1 (ISO 8859-1) character set; see iso_8859_1(7).
lbp    Output for Canon CAPSL printers (LBP-4 and LBP-8 series laser printers).
lj4    HP LaserJet4-compatible (or other PCL5-compatible) printers.
ps     PostScript output; suitable for printers and previewers like gv(1).
pdf    PDF files; suitable for viewing with tools such as evince(1) and okular(1).
utf8   Text output using the Unicode (ISO 10646) character set with UTF-8 encoding; see unicode(7).
xhtml  XHTML output.
X75    75dpi X Window System output suitable for the previewers xditview(1x) and gxditview(1).  A variant for a 12pt document base font is X75-12.
X100   100dpi X Window System output suitable for the previewers xditview(1x) and gxditview(1).  A variant for a 12pt document base font is X100-12.
The postprocessor to be used for a device is specified by the postpro command in the device description file; see groff_font(5).  This can be overridden with the -X option.
Postprocessors groff provides 3 hardware postprocessors:
grolbp(1) for some Canon printers,
grolj4(1) for printers compatible to the HP LaserJet 4 and PCL5,
grotty(1) for text output using various encodings, e.g., on text-oriented terminals or line printers.
Today, most printing or drawing hardware is handled by the operating system, by device drivers, or by software interfaces, usually accepting PostScript.  Consequently, there isn't an urgent need for more hardware device postprocessors.
The groff software devices for conversion into other document file formats are
grodvi(1) for the DVI format,
grohtml(1) for HTML and XHTML formats,
grops(1) for PostScript.
gropdf(1) for PDF.
Combined with the many existing free conversion tools this should be sufficient to convert a troff document into virtually any existing data format.
Utilities The following utility programs around groff are available.
addftinfo(1) Add information to troff font description files for use with groff.
afmtodit(1) Create font description files for PostScript device.
eqn2graph(1) Convert an eqn image into a cropped image.
gdiffmk(1) Mark differences between groff, nroff, or troff files.
grap2graph(1) Convert a grap diagram into a cropped bitmap image.
groffer(1) General viewer program for groff files and man pages.
gxditview(1) The groff X viewer, the GNU version of xditview.
hpftodit(1) Create font description files for lj4 device.
indxbib(1) Make inverted index for bibliographic databases.
lkbib(1) Search bibliographic databases.
lookbib(1) Interactively search bibliographic databases.
pdfroff(1) Create PDF documents using groff.
pfbtops(1) Translate a PostScript font in .pfb format to ASCII.
pic2graph(1) Convert a pic diagram into a cropped image.
tfmtodit(1) Create font description files for TeX DVI device.
xditview(1x) roff viewer historically distributed with the X Window System.
xtotroff(1) Convert X font metrics into GNU troff font metrics.
Normally, the path separator in the following environment variables is the colon; this may vary depending on the operating system.  For example, DOS and Windows use a semicolon instead.
GROFF_BIN_PATH This search path, followed by PATH, is used for commands that are executed by groff.  If it is not set then the directory where the groff binaries were installed is prepended to PATH.
GROFF_COMMAND_PREFIX When there is a need to run different roff implementations at the same time groff provides the facility to prepend a prefix to most of its programs that could provoke name clashings at run time (default is to have none).  Historically, this prefix was the character g, but it can be anything.  For example, gtroff stood for groff's troff, gtbl for the groff version of tbl.  By setting GROFF_COMMAND_PREFIX to different values, the different roff installations can be addressed.  More exactly, if it is set to prefix xxx then groff as a wrapper program internally calls xxxtroff instead of troff.  This also applies to the preprocessors eqn, grn, pic, refer, tbl, soelim, and to the utilities indxbib and lookbib.  This feature does not apply to any programs different from the ones above (most notably groff itself) since they are unique to the groff package.
GROFF_ENCODING The value of this environment value is passed to the preconv preprocessor to select the encoding of input files.  Setting this option implies groff's command-line option -k (this is, groff actually always calls preconv).  If set without a value, groff calls preconv without arguments.  An explicit -K command-line option overrides the value of GROFF_ENCODING.  See preconv(1) for details.
GROFF_FONT_PATH A list of directories in which to search for the devname directory in addition to the default ones.  See troff(1) and groff_font(5) for more details.
GROFF_TMAC_PATH A list of directories in which to search for macro files in addition to the default directories.  See troff(1) and groff_tmac(5) for more details.
GROFF_TMPDIR The directory in which temporary files are created.  If this is not set but the environment variable TMPDIR instead, temporary files are created in the directory TMPDIR.  On MS-DOS and Windows platforms, the environment variables TMP and TEMP (in that order) are searched also, after GROFF_TMPDIR and TMPDIR.  Otherwise, temporary files are created in /tmp.  The refer(1), groffer(1), grohtml(1), and grops(1) commands use temporary files.
GROFF_TYPESETTER Preset the default device.  If this is not set the ps device is used as default.  This device name is overwritten by the option -T.
The following example illustrates the power of the groff program as a wrapper around troff.
To process a roff file using the preprocessors tbl and pic and the me macro set, classical troff had to be called by
pic foo.me | tbl | troff -me -Tlatin1 | grotty
Using groff, this pipe can be shortened to the equivalent command
groff -p -t -me -T latin1 foo.me
An even easier way to call this is to use grog(1) to guess the preprocessor and macro options and execute the generated command (by using backquotes to specify shell command substitution)
`grog -Tlatin1 foo.me`
The simplest way is to view the contents in an automated way by calling
groffer foo.me
On EBCDIC hosts (e.g., OS/390 Unix), output devices ascii and latin1 aren't available.  Similarly, output for EBCDIC code page cp1047 is not available on ASCII based operating systems.
groff installs files in varying locations depending on its compile-time configuration.  On this installation, the following locations are used.
/usr/share/X11/app-defaults Application defaults directory for gxditview(1).
/usr/bin Directory containing groff's executable commands.
/usr/share/groff/1.22.4/eign List of common words for indxbib(1).
/usr/share/groff/1.22.4 Directory for data files.
/usr/dict/papers/Ind Default index for lkbib(1) and refer(1).
/usr/share/doc/groff-1.22.4 Documentation directory.
/usr/share/doc/groff-1.22.4/examples Example directory.
/usr/share/groff/1.22.4/font Font directory.
/usr/share/doc/groff-1.22.4/html HTML documentation directory.
/usr/lib/font Legacy font directory.
/usr/share/groff/site-font Local font directory.
/usr/share/groff/site-tmac Local macro package (tmac file) directory.
/usr/share/groff/1.22.4/tmac Macro package (tmac file) directory.
/usr/share/groff/1.22.4/oldfont Font directory for compatibility with old versions of groff; see grops(1).
/usr/share/doc/groff-1.22.4/pdf PDF documentation directory.
/usr/lib/groff/site-tmac System macro package (tmac file) directory.
groff Macro Directory This contains all information related to macro packages.  Note that more than a single directory is searched for those files as documented in groff_tmac(5).  For the groff installation corresponding to this document, it is located at /usr/share/groff/1.22.4/tmac.  The following files contained in the groff macro directory have a special meaning:
troffrc Initialization file for troff.  This is interpreted by troff before reading the macro sets and any input.
troffrc-end Final startup file for troff.  It is parsed after all macro sets have been read.
name.tmac tmac.name Macro file for macro package name.
groff Font Directory This contains all information related to output devices.  Note that more than a single directory is searched for those files; see troff(1).  For the groff installation corresponding to this document, it is located at /usr/share/groff/1.22.4/font.  The following files contained in the groff font directory have a special meaning:
devname/DESC Device description file for device name, see groff_font(5).
devname/F Font file for font F of device name.
Information on how to get groff and related information is available at the groff page of the GNU website ⟨http://www.gnu.org/software/groff⟩.
Three groff mailing lists are available:
bug tracker activity (read-only) ⟨bug-groff@gnu.org⟩;
general discussion ⟨groff@gnu.org⟩; and
commit activity (read-only) ⟨groff-commit@gnu.org⟩, which reports changes to groff's source code repository by its developers.
Details on repository access and much more can be found in the file README at the top directory of the groff source package.
A free implementation of the grap preprocessor, written by Ted Faber ⟨faber@lunabase.org⟩, can be found at the grap website ⟨http:// www.lunabase.org/~faber/Vault/software/grap/⟩.  This is the only grap supported by groff.
groff was written by James Clark ⟨jjc@jclark.com⟩.  This document was rewritten, enhanced, and put under the FDL license in 2002 by Bernd Warken ⟨groff-bernd.warken-72@web.de⟩.
Groff: The GNU Implementation of troff, by Trent A. Fisher and Werner Lemberg, is the primary groff manual.  You can browse it interactively with “info groff”.
Due to its complex structure, the groff system has many man pages.  They can be read with man(1) or groffer(1).
But there are special sections of man pages.  groff has man pages in sections 1, 5,and 7.  When there are several man pages with the same name in the same man section, the one with the lowest section is should as first.  The other man pages can be shown anyway by adding the section number as argument before the man page name.  Reading the man page about the groff language is done by one of man 7 groff groffer 7 groff
Introduction, history and further readings: roff(7).
Viewer for groff files: groffer(1), gxditview(1), xditview(1x).
Wrapper programs for formatters: groff(1), grog(1).
Roff preprocessors: eqn(1), grn(1), pic(1), chem(1), preconv(1), refer(1), soelim(1), tbl(1), grap(1).
Roff language with the groff extensions: groff(7), groff_char(7), groff_diff(7), groff_font(5).
Roff formatter programs: nroff(1), troff(1), ditroff(7).
The intermediate output language: groff_out(7).
Postprocessors for the output devices: grodvi(1), grohtml(1), grolbp(1), grolj4(1), lj4_font(5), grops(1), gropdf(1), grotty(1).
Groff macro packages and macro-specific utilities: groff_tmac(5), groff_man(7), groff_mdoc(7), groff_me(7), groff_mm(7), groff_mmse(7), groff_mom(7), groff_ms(7), groff_www(7), groff_trace(7), mmroff(7).
The following utilities are available: addftinfo(1), afmtodit(1), eqn2graph(1), gdiffmk(1), grap2graph(1), groffer(1), gxditview(1), hpftodit(1), indxbib(1), lkbib(1), lookbib(1), pdfroff(1), pfbtops(1), pic2graph(1), tfmtodit(1), xtotroff(1).
clamscan(1)                      Clam AntiVirus                      clamscan(1)
clamscan - scan files and directories for viruses
clamscan [options] [file/directory/-]
clamscan is a command line anti-virus scanner.
Most of the options are simple switches which enable or disable some features. Options marked with [=yes/no(*)] can be optionally followed by =yes/=no; if they get called without the boolean argument the scanner will assume 'yes'. The asterisk marks the default internal setting for a given option.
-h, --help Print help information and exit.
-V, --version Print version number and exit.
-a, --archive-verbose Show filenames inside scanned archives
--debug Display debug messages from libclamav.
--quiet Be quiet (only print error messages).
--stdout Write all messages (except for libclamav output) to the standard output (stdout).
--no-summary Do not display summary at the end of scanning.
-i, --infected Only print infected files.
-o, --suppress-ok-results Skip printing OK files
--bell Sound bell on virus detection.
--tempdir=DIRECTORY Create temporary files in DIRECTORY. Directory must be writable for the 'clamav' user or unprivileged user running clamscan.
--leave-temps Do not remove temporary files.
--gen-json Generate JSON description of scanned file(s). JSON will be printed and also dropped to the temp directory if --leave-temps is enabled.
-d FILE/DIR, --database=FILE/DIR Load virus database from FILE or load all virus database files from DIR.
--official-db-only=[yes/no(*)] Only load the official signatures published by the ClamAV project.
-l FILE, --log=FILE Save scan report to FILE.
-r, --recursive Scan directories recursively. All the subdirectories in the given directory will be scanned.
-z, --allmatch After a match, continue scanning within the file for additional matches.
--cross-fs=[yes(*)/no] Scan files and directories on other filesystems.
--follow-dir-symlinks=[0/1(*)/2] Follow directory symlinks. There are 3 options: 0 - never follow directory symlinks, 1 (default) - only follow directory symlinks, which are passed as direct arguments to clamscan. 2 - always follow directory symlinks.
--follow-file-symlinks=[0/1(*)/2] Follow file symlinks. There are 3 options: 0 - never follow file symlinks, 1 (default) - only follow file symlinks, which are passed as direct arguments to clamscan. 2 - always follow file symlinks.
-f FILE, --file-list=FILE Scan files listed line by line in FILE.
--remove[=yes/no(*)] Remove infected files. Be careful!
--move=DIRECTORY Move infected files into DIRECTORY. Directory must be writable for the 'clamav' user or unprivileged user running clamscan.
--copy=DIRECTORY Copy infected files into DIRECTORY. Directory must be writable for the 'clamav' user or unprivileged user running clamscan.
--exclude=REGEX, --exclude-dir=REGEX Don't scan file/directory names matching regular expression. These options can be used multiple times.
--include=REGEX, --include-dir=REGEX Only scan file/directory matching regular expression. These options can be used multiple times.
--bytecode[=yes(*)/no] With this option enabled ClamAV will load bytecode from the database. It is highly recommended you keep this option turned on, otherwise you may miss detections for many new viruses.
--bytecode-unsigned[=yes/no(*)] Allow loading bytecode from outside digitally signed .c[lv]d files. **Caution**: You should NEVER run bytecode signatures from untrusted sources. Doing so may result in arbitrary code execution.
--bytecode-timeout=N Set bytecode timeout in milliseconds (default: 5000 = 5s)
--statistics[=none(*)/bytecode/pcre] Collect and print execution statistics.
--detect-pua[=yes/no(*)] Detect Possibly Unwanted Applications.
--exclude-pua=CATEGORY Exclude a specific PUA category. This option can be used multiple times. See https://docs.clamav.net/faq/faq-pua.html for the complete list of PUA
--include-pua=CATEGORY Only include a specific PUA category. This option can be used multiple times. See https://docs.clamav.net/faq/faq-pua.html for the complete list of PUA
--detect-structured[=yes/no(*)] Use the DLP (Data Loss Prevention) module to detect SSN and Credit Card numbers inside documents/text files.
--structured-ssn-format=X X=0: search for valid SSNs formatted as xxx-yy-zzzz (normal); X=1: search for valid SSNs formatted as xxxyyzzzz (stripped); X=2: search for both formats. Default is 0.
--structured-ssn-count=#n This option sets the lowest number of Social Security Numbers found in a file to generate a detect (default: 3).
--structured-cc-count=#n This option sets the lowest number of Credit Card numbers found in a file to generate a detect (default: 3).
--scan-mail[=yes(*)/no] Scan mail files. If you turn off this option, the original files will still be scanned, but without parsing individual messages/attachments.
--phishing-sigs[=yes(*)/no] Enable email signature-based phishing detection.
--phishing-scan-urls[=yes(*)/no] Enable URL signature-based phishing detection (Heuristics.Phishing.Email.*)
--heuristic-alerts[=yes(*)/no] In some cases (eg. complex malware, exploits in graphic files, and others), ClamAV uses special algorithms to provide accurate detection. This option can be used to control the algorithmic detection.
--heuristic-scan-precedence[=yes/no(*)] Allow heuristic match to take precedence. When enabled, if a heuristic scan (such as phishingScan) detects a possible virus/phish it will stop scan immediately. Recommended, saves CPU scan-time. When disabled, virus/phish detected by heuristic scans will be reported only at the end of a scan. If an archive contains both a heuristically detected  virus/phish, and a real malware, the real malware will be reported Keep this disabled if you intend to handle "Heuristics.*" viruses  differently from "real" malware. If a non-heuristically-detected virus (signature-based) is found first,  the scan is interrupted immediately, regardless of this config option.
--normalize[=yes(*)/no] Normalize (compress whitespace, downcase, etc.) html, script, and text files. Use normalize=no for yara compatibility.
--scan-pe[=yes(*)/no] PE stands for Portable Executable - it's an executable file format used in all 32-bit versions of Windows operating systems. By default ClamAV performs deeper analysis of executable files and attempts to decompress popular executable packers such as UPX, Petite, and FSG. If you turn off this option, the original files will still be scanned but without additional processing.
--scan-elf[=yes(*)/no] Executable and Linking Format is a standard format for UN*X executables. This option controls the ELF support. If you turn it off, the original files will still be scanned but without additional processing.