.\" Man page generated from reStructuredText.
.
.TH "AUTOSUSPEND" "1" "Jan 22, 2020" "3.0" "autosuspend"
.SH NAME
autosuspend \- autosuspend Documentation
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBautosuspend\fP [\fIoptions\fP] \fBdaemon|presuspend\fP [\fIsubcommand options\fP]
.SH DESCRIPTION
.sp
\fBautosuspend\fP is a daemon that periodically suspends a system on inactivity and wakes it up again automatically in case it is needed.
For this purpose, \fBautosuspend\fP periodically iterates a number of user\-configurable activity checks, which indicate whether an activity on the host is currently present that should prevent the host from suspending.
In case one of the checks indicates such activity, no action is taken and periodic checking continues.
Otherwise, in case no activity can be detected, this state needs to be present for a specified amount of time before the host is suspended by \fBautosuspend\fP\&.
In addition to the activity checks, wake up checks are used to determine planned future activities of the system (for instance, a TV recording or a periodic backup).
In case such activities are known before suspending, \fBautosuspend\fP triggers a command to wake up the system automatically before the soonest activity.
.sp
If not specified via a command line argument, \fBautosuspend\fP looks for a default configuration at \fB/etc/autosuspend.conf\fP\&.
\fBautosuspend.conf(5)\fP describes the configuration file, the available checks, and their configuration options.
.SH OPTIONS
.SS Command line options
.sp
General syntax:
.INDENT 0.0
.INDENT 3.5
\fBautosuspend\fP [\fIoptions\fP] \fBdaemon|presuspend\fP [\fIsubcommand options\fP]
.UNINDENT
.UNINDENT
.SS General options
.INDENT 0.0
.TP
.B \-h, \-\-help
Displays an online help.
.UNINDENT
.INDENT 0.0
.TP
.B \-c FILE, \-\-config FILE
Specifies an alternate config file to use instead of the default on at \fB/etc/autosuspend.conf\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-l FILE, \-\-logging FILE
Configure the logging system with the provided logging file.
This file needs to follow the conventions for Python logging files\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-d
Configure full debug logging in the command line.
Mutually exclusive to \fI\%autosuspend \-l\fP\&.
.UNINDENT
.SS Subcommand \fBdaemon\fP
.sp
Starts the continuously running daemon.
.INDENT 0.0
.TP
.B \-a, \-\-allchecks
Usually, \fBautosuspend\fP stops checks in each iteration as soon as the first matching check indicates system activity.
If this flag is set, all subsequent checks are still executed.
Useful mostly for debugging purposes.
.UNINDENT
.INDENT 0.0
.TP
.B \-r SECONDS, \-\-runfor SECONDS
If specified, do not run endlessly.
Instead, operate only for the specified amount of seconds, then exit.
Useful mostly for debugging purposes.
.UNINDENT
.SS Subcommand \fBpresuspend\fP
.sp
Should be called by the system before suspending.
.sp
No options
.SH BUGS
.sp
Please report bugs at the project repository at \fI\%https://github.com/languitar/autosuspend\fP\&.
.SH SEE ALSO
.sp
\fBautosuspend.conf(5)\fP
.SH AUTHOR
Johannes Wienke
.SH COPYRIGHT
2020, Johannes Wienke
.\" Generated by docutils manpage writer.
.