<?xml version="1.0" encoding="UTF-8"?>
<!-- **************************************************************************
.... For copyright and licensing terms, see the file named COPYING.
.... **************************************************************************
.-->
<?xml-stylesheet href="docbook-xml.css" type="text/css"?>

<refentry id="monitor-fsck-progress">

<refmeta xmlns:xi="http://www.w3.org/2001/XInclude">
<refentrytitle>monitor-fsck-progress</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="manual">user commands</refmiscinfo>
<refmiscinfo class="source">nosh</refmiscinfo>
<xi:include href="version.xml" />
</refmeta>

<refnamediv>
<refname>monitor-fsck-progress</refname>
<refpurpose>monitor the progress of one or more fscks</refpurpose>
</refnamediv>

<refsynopsisdiv>
<cmdsynopsis>
<command>monitor-fsck-progress</command>
</cmdsynopsis>
</refsynopsisdiv>

<refsection><title>Description</title>

<para>
<command>monitor-fsck-progress</command> expects file descriptor 3 to be a socket that has been set up with <citerefentry><refentrytitle>local-stream-socket-listen</refentrytitle><manvolnum>1</manvolnum></citerefentry> or <citerefentry><refentrytitle>tcp-socket-listen</refentrytitle><manvolnum>1</manvolnum></citerefentry> to listen for incoming (local or TCP/IP) socket connections.
It loops forever, accepting socket connections and (for each such connection) listening for progress reports generated by <citerefentry><refentrytitle>fsck</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>

<para>
It displays, on the terminal connected to its standard output, progress bars for all client instances of <command>fsck</command>.
There is one progress bar per currently connected client.
It uses <citerefentry><refentrytitle>TerminalCapabilities</refentrytitle><manvolnum>3</manvolnum></citerefentry> and an <code>ECMA48Output</code> class to create the progress bars, switching to the alternate screen buffer (if there is one).
</para>

<para>
<command>monitor-fsck-progress</command> is the meat of the <filename>monitor-fsck-progress</filename> service, which directs its output to <filename>/dev/console</filename>.
</para>

</refsection><refsection><title>Author</title>
<para><author><personname><firstname>Jonathan</firstname> <surname>de Boyne Pollard</surname></personname></author></para>
</refsection>

</refentry>
