Package: lua-busted
Tags: patch

Hi,

Please consider adding the attached manpage for the binary: busted

Thanks and regards,
Nilesh

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.16.
.TH BUSTED "1" "December 2020" "busted 2.0.0" "User Commands"
.SH NAME
busted \- Lua unit testing framework focused on ease of use
.SH DESCRIPTION
busted: error: Usage: busted [OPTIONS] [\-\-] [ROOT\-1 [ROOT\-2 [...]]]
.SS "ARGUMENTS:"
.TP
ROOT
test script file/folder. Folders will be
traversed for any file that matches the
\fB\-\-pattern\fR option. (optional, default: nil)
.SS "OPTIONS:"
.TP
\fB\-\-version\fR
prints the program version and exits
.TP
\fB\-p\fR, \fB\-\-pattern\fR=\fI\,PATTERN\/\fR
only run test files matching the Lua
pattern (default: _spec)
.TP
\fB\-\-exclude\-pattern\fR=\fI\,PATTERN\/\fR do not run test files matching the 
Lua
pattern, takes precedence over \fB\-\-pattern\fR
.TP
\fB\-e\fR STATEMENT
execute statement STATEMENT
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,LIBRARY\/\fR
output library to load (default:
plainTerminal)
.TP
\fB\-C\fR, \fB\-\-directory\fR=\fI\,DIR\/\fR
change to directory DIR before running
tests. If multiple options are specified,
each is interpreted relative to the
previous one. (default: ./)
.TP
\fB\-f\fR, \fB\-\-config\-file\fR=\fI\,FILE\/\fR
load configuration options from FILE
.TP
\fB\-t\fR, \fB\-\-tags\fR=\fI\,TAGS\/\fR
only run tests with these #tags (default:
[])
.TP
\fB\-\-exclude\-tags\fR=\fI\,TAGS\/\fR
do not run tests with these #tags, takes
precedence over \fB\-\-tags\fR (default: [])
.TP
\fB\-\-filter\fR=\fI\,PATTERN\/\fR
only run test names matching the Lua
pattern (default: [])
.TP
\fB\-\-filter\-out\fR=\fI\,PATTERN\/\fR
do not run test names matching the Lua
pattern, takes precedence over \fB\-\-filter\fR
(default: [])
.TP
\fB\-m\fR, \fB\-\-lpath\fR=\fI\,PATH\/\fR
optional path to be prefixed to the Lua
module search path (default:
\&./src/?.lua;./src/?/?.lua;./src/?/init.lua)
.TP
\fB\-\-cpath\fR=\fI\,PATH\/\fR
optional path to be prefixed to the Lua C
module search path (default:
\&./csrc/?.so;./csrc/?/?.so;)
.TP
\fB\-r\fR, \fB\-\-run\fR=\fI\,RUN\/\fR
config to run from .busted file
.TP
\fB\-\-repeat\fR=\fI\,COUNT\/\fR
run the tests repeatedly (default: 1)
.TP
\fB\-\-seed\fR=\fI\,SEED\/\fR
random seed value to use for shuffling test
order (default: \fI\,/dev/urandom\/\fP or os.time())
.TP
\fB\-\-lang\fR=\fI\,LANG\/\fR
language for error messages (default: en)
.TP
\fB\-\-loaders\fR=\fI\,NAME\/\fR
test file loaders (default: lua,moonscript)
.TP
\fB\-\-helper\fR=\fI\,PATH\/\fR
A helper script that is run before tests
.TP
\fB\-\-lua\fR=\fI\,LUA\/\fR
The path to the lua interpreter busted
should run under
.TP
\fB\-Xoutput\fR OPTION
pass `OPTION` as an option to the output
handler. If `OPTION` contains commas, it is
split into multiple options at the commas.
(default: [])
.TP
\fB\-Xhelper\fR OPTION
pass `OPTION` as an option to the helper
script. If `OPTION` contains commas, it is
split into multiple options at the commas.
(default: [])
.TP
\fB\-c\fR, \fB\-\-[no\-]coverage\fR
do code coverage analysis (requires
`LuaCov` to be installed) (default: off)
.TP
\fB\-v\fR, \fB\-\-[no\-]verbose\fR
verbose output of errors (default: off)
.TP
\fB\-s\fR, \fB\-\-[no\-]enable\-sound\fR
executes `say` command if available
(default: off)
.TP
\fB\-l\fR, \fB\-\-list\fR
list the names of all tests instead of
running them
.TP
\fB\-\-ignore\-lua\fR
Whether or not to ignore the lua directive
.TP
\fB\-\-[no\-]lazy\fR
use lazy setup/teardown as the default
(default: off)
.TP
\fB\-\-[no\-]auto\-insulate\fR
enable file insulation (default: on)
.TP
\fB\-k\fR, \fB\-\-[no\-]keep\-going\fR
continue as much as possible after an error
or failure (default: on)
.TP
\fB\-R\fR, \fB\-\-[no\-]recursive\fR
recurse into subdirectories (default: on)
.TP
\fB\-\-[no\-]shuffle\fR
randomize file and test order, takes
precedence over \fB\-\-sort\fR (\fB\-\-shuffle\-test\fR and
\fB\-\-shuffle\-files\fR) (default: off)
.TP
\fB\-\-[no\-]shuffle\-files\fR
randomize file execution order, takes
precedence over \fB\-\-sort\-files\fR (default: off)
.TP
\fB\-\-[no\-]shuffle\-tests\fR
randomize test order within a file, takes
precedence over \fB\-\-sort\-tests\fR (default: off)
.TP
\fB\-\-[no\-]sort\fR
sort file and test order (\fB\-\-sort\-tests\fR and
\fB\-\-sort\-files\fR) (default: off)
.TP
\fB\-\-[no\-]sort\-files\fR
sort file execution order (default: off)
.TP
\fB\-\-[no\-]sort\-tests\fR
sort test order within a file (default:
off)
.TP
\fB\-\-[no\-]suppress\-pending\fR
suppress `pending` test output (default:
off)
.TP
\fB\-\-[no\-]defer\-print\fR
defer print to when test suite is complete
(default: off)
.PP
; re\-run with \fB\-\-help\fR for usage.
.SH AUTHOR
 This manpage was written by Nilesh Patra for the Debian distribution and
 can be used for any other usage of the program.

Attachment: signature.asc
Description: OpenPGP digital signature

Reply via email to