~~NOTOC~~
====== xfce4-time-out-plugin - Time Out ======

Xfce4-time-out-plugin makes it possible to take periodical breaks from the computer at user-configurable intervals (specified in minutes and seconds). During breaks it suspends your screen (for a time period that is also configurable), preventing user input. It optionally allows you to postpone breaks for a certain time.

The idea is inherited from [[https://wiki.gnome.org/Attic/drwright|DrWright]], a plugin originating with GNOME. 

  * **[[#Screenshots|Screenshots]]**
  * **[[#Required Packages|Required Packages]]**
  * **[[#Latest Release|Latest Release]]**
  * **[[#Source Code Repository|Source Code Repository]]**
  * **[[#Reporting Bugs|Reporting Bugs]]**

----

===== Usage =====

  - [[:xfce:xfce4-panel:add-new-items|Add the plugin to the panel]].
  - Right-click on the added plugin, select **Properties** to open the settings window. 

In the properties dialog, the following options are configurable:

  * Duration (length) of each break (default: 5 minutes)
  * Time between breaks (default: 30 minutes)
  * Postpone time (default: 2 minutes)
  * Allow breaks to be postponed
  * Display seconds in the panel
  * Display hours in the panel
  * Display the remaining time until the next break at all

The plugin also offers a context menu which can:

  * deactivate the plugin easily
  * take a break instantly

----

===== Screenshots =====

<figure "Time Out Plugin Configuration Dialog Window">
{{:panel-plugins:time_out-properties.png|Time Out Plugin Configuration Dialog Window}}
</figure>

<figure "Time Out Plugin Panel Indicator">
{{:panel-plugins:time_out-panel-20110120.png|Time Out Plugin Panel Indicator}}
</figure>

<figure "Time Out Plugin Right-Click Context Menu">
{{:panel-plugins:time_out-cm-20110120.png|Time Out Plugin Right-Click Context Menu}}
</figure>

<figure "Time Out Plugin Screen Lock During Breaks">
{{:panel-plugins:time_out-break-dialog.png?600|Time Out Plugin Screen Lock During Breaks}}
</figure>

[[|Back To Top]]
----

===== Required Packages =====

  * [[https://www.gtk.org|GTK+-3.0]]
  * [[https://gitlab.xfce.org/xfce/libxfce4util|libxfce4util]]
  * [[https://gitlab.xfce.org/xfce/xfce4-panel|xfce4-panel]]

For detailed information on the minimum required versions, check the [[https://gitlab.xfce.org/panel-plugins/xfce4-time-out-plugin/-/blob/master/configure.ac.in|configure.ac.in]] file.

----

===== Latest Release =====

{{rss>https://archive.xfce.org/feeds/project/xfce4-time-out-plugin 1 date 2h}}

[[https://gitlab.xfce.org/panel-plugins/xfce4-time-out-plugin/-/blob/master/NEWS|Read the CHANGELOG]]

  * **[[https://archive.xfce.org/src/panel-plugins/xfce4-time-out-plugin/|Download current release]]** (older versions of this component are also available here)

[[|Back to Top]]
----

===== Source code repository =====

[[https://gitlab.xfce.org/panel-plugins/xfce4-time-out-plugin]]

----

===== Reporting Bugs =====

  * **[[:panel-plugins:xfce4-time-out-plugin:bugs|Reporting Bugs]]** -- List of currently open bugs and instructions on how to submit new bug reports

[[|Back To Top]]
----
[[:xfce:xfce4-panel:start:|Return to xfce4-panel Main Documentation Page]]