:orphan:

stressant manual page
=====================

Synopsis
--------

.. this and parts below are just copy-pasted from the output of
   --help. this, in particular, is reformatted to be on a single
   line...

**stressant** [-h] [-v] [--logfile LOGFILE] [--email EMAIL] [--smtpserver SMTPSERVER] [--smtpuser SMTPUSER] [--smtppass SMTPPASS] [--information] [--disk] [--no-smart] [--diskDevice DISKDEVICE] [--overwrite] [--diskPercent DISKPERCENT] [--fileSize FILESIZE] [--cpu] [--cpuBurnTime CPUBURNTIME] [--network] [--iperfServer IPERFSERVER] [--iperfTime IPERFTIME]

Description
-----------

.. ... and this is the epilog, just copy-pasted here...

Stressant is a simple yet complete stress-testing tool that forces a computer
to perform a series of test using well-known Linux software in order to detect
possible design or construction failures.

Options
-------

.. ... and this is directly copy-pasted from the usage.

  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  --logfile LOGFILE     write reports to the given logfile (default: None)
  --email EMAIL         send report by email to given address
  --smtpserver SMTPSERVER
                        SMTP server to use, use a colon to specify the port
                        number if non-default (25). willl attempt to use
                        STARTTLS to secure the connexion and fail if
                        unsupported (default: deliver using the --mta command)
  --smtpuser SMTPUSER   username for the SMTP server (default: no user)
  --smtppass SMTPPASS   password for the SMTP server (default: prompted, if
                        --smtpuser is specified)
  --information, --no-information
                        gather basic information (default: True)
  --disk, --no-disk     run disk tests (default: True)
  --no-smart, --smart   run SMART tests (default: False)
  --diskDevice DISKDEVICE
                        device to benchmark (default: /dev/sda)
  --overwrite           actually destroy the given device (default: False)
  --diskPercent DISKPERCENT
                        how much of the disk to trash (default: 0%)
  --fileSize FILESIZE   file size for I/O benchmarks (default: 100M)
  --cpu, --no-cpu       run CPU tests (default: True)
  --cpuBurnTime CPUBURNTIME
                        timeout for CPU burn-in (default: 1m)
  --network, --no-network
                        run network tests (default: True)
  --iperfServer IPERFSERVER
                        iperf server to use (default: iperf.he.net)
  --iperfTime IPERFTIME
                        timeout for iperf test, in seconds (default: 60)

Examples
--------

Small run load with defaults::

  stressant

Very fast test, useful to run if you are worried about crashing the
machine::

  stressant --fileSize 1M --cpuBurnTime 1s --iperfTime 1

Extensive test with complete disk wipe and SMART long test::

  sudo stressant --diskPercent 100% --overwrite --cpuBurnTime 24h --smart
  # wait for the prescribed time, then show the SMART test results:
  sudo smartctl -l selftest

Network test only on dedicated server::

  stressant --no-information --no-cpu --no-disk --iperfServer iperf.example.net

Send test results by email::

  stressant --email person@example.com

If the mail server refuses mail from your location, you can use
another relay (password will be prompted)::

  stressant --email person@example.com --smtpserver submission.example.net --smtpuser person --smtppassword

See also
--------

:manpage:`hdparm(8)`, :manpage:`smartctl(8)`, :manpage:`dd(1)`,
:manpage:`fio()`, :manpage:`stress-ng(1)`, :manpage:`iperf3(1)`
