1.\"
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2018 Mateusz Piotrowski <0mp@FreeBSD.org>
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions are met:
9.\"
10.\" 1. Redistributions of source code must retain the above copyright notice,
11.\"    this list of conditions and the following disclaimer.
12.\"
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27.\" POSSIBILITY OF SUCH DAMAGE.
28.\"
29.Dd April 30, 2018
30.Dt COFFEEBREAK 6
31.Os
32.Sh NAME
33.Nm coffeebreak
34.Nd "pretend your machine is busy with a fake FreeBSD installer"
35.Sh SYNOPSIS
36.Nm
37.Op Fl f Ar files
38.Op Fl i Ar increase
39.Op Fl p Ar barsize
40.Op Fl s Ar seconds
41.Op Fl w Ar width
42.Sh DESCRIPTION
43.Nm
44is a a fake
45.Fx
46installer.
47.Pp
48It's friday.
49Do you need to pretend to be working?
50Do you have
51.Fx
52systems?
53Here you go!
54.Nm
55is the tool you always wanted to make your machine as if it is very busy doing
56important stuff.
57.Pp
58The options are as follows:
59.Bl -tag -width ".Fl -f Ar files"
60.It Fl f Ar files
61Set the list of space-separated files to fake-fetch.
62Default value:
63.Dq Li "base.txz dict.txz doc.txz games.txz ports.txz src.txz" .
64.It Fl i Ar increase
65Set the number of percentage points to increment each time.
66.Ar increase
67must be even divisor of 100.
68Default value:
69.Dq Li 1 .
70.It Fl p Ar barsize
71Set the size of the mini-progressbar.
72Default value:
73.Dq Li 17 .
74.It Fl s Ar seconds
75Set the number of seconds to sleep in-between increments.
76.Ar n
77does not have to be an integer.
78Default value:
79.Dq Li 3 .
80.It Fl w Ar width
81Set the maximum width for labels (file names defined via the
82.Ev files
83environmental variable).
84Default value:
85.Dq Li 28 .
86.El
87.Sh ENVIRONMENT
88Those environmental are always overwritten by command-line options.
89.Pp
90Here is a list of environmental variables affecting the execution of
91.Nm :
92.Bl -tag -width ".Ev increment"
93.It Ev files
94Files to fake-fetch.
95Default value:
96.Dq Li "base.txz dict.txz doc.txz games.txz ports.txz src.txz" .
97.It Ev increment
98The number of percentage points to increment each time (must be even divisor of
99100).
100Default value:
101.Dq Li 1 .
102.It Ev pbar_size
103The size of the mini-progressbar.
104Default value:
105.Dq Li 17 .
106.It Ev sleep_sec
107The time to sleep in-between increments.
108Default value:
109.Dq Li 3 .
110.It Ev txt_size
111The maximum width for labels (file names defined via the
112.Ev files
113environmental variable).
114Default value:
115.Dq Li 28 .
116.El
117.Sh AUTHORS
118.Nm
119was originally written by
120.An Devin Teske Aq Mt dteske@FreeBSD.org
121and then packaged and documented
122by
123.An -nosplit
124.An Mateusz Piotrowski Aq Mt 0mp@FreeBSD.org .
125