[docs] Remove commented out section from man page

We don't have a --version and it was adding a gap in the output

[docs] Update home page url in man page

[docs] Fix AUTHORS in man page

[docs] Clarify "rhgb" cmdline option in man page

Previously, it said that "rhgb" was required for plymouth
to run, but plymouth runs no matter what.  This just
specifies which splash is displayed

[docs] Remove instructions about boot loader

They weren't completely accurate, you don't need to reinstall
grub after editing its config, since it has built-in filesystem
drivers.  Also, those details very from system to system, so we
should probably just leave it out.

[docs] Add reference to splash cmdline in man page

It referenced rhgb, but not splash.  While rhgb was
there first, most distributions use splash since it's
more logical (among other reasons).

[docs] Remove distribution references from man page

We don't want to provide a history of what distributions
used before plymouth, because that history could get long,
isn't super relevant, and will add noise for a users looking
for help (they probably only care about their distributions,
not others).

[docs] Rename man/ to docs/

This way we can put other documents there as well.

[docs] Add man page

It explains the basic concepts of plymouth and the usage of tools to be
used to setup it.

[set-default-theme] Provide GNU-style short options

[set-default-theme] Make --help format match that of plymouth and plymouthd

Minor rejig to make the help messages more consistant. Also removes some tabs
and empty lines.

[set-default-theme] Call usage function in --help

This way the top line of the help output gives usage.

[set-default-theme] Add --help option

When running new, unfamiliar commands I usually invoke them with
--help to see what options they have. For plymouth-set-default-theme,
there is no --help option which I find a bit confusing, especially
since the usage is not straight-forward.

There is now an additional function "show_help" which displays an
help output when invoking plymouth-set-default-theme with --help.

[main] Fix fd leak

When redirecting stdio to the tty, the
tty was opened and its fd was dup()'d to
the standard ones, but then wasn't closed.

[script] Add widow get position functions

These are the Window.GetX/Y that pair up with Window.SetX/Y already present.
They return the position of the window.

[configure] Make maintainer mode default to on but not explicit in autogen

Maintainer mode is assumed on when executing configure, and thus is not needed
within autogen.

[viewer] Quit on window close when not in icon mode.

Previously, in non-icon mode when clicking on the window decoration close, the
window would hide and carry on running. It should quit.

https://bugs.freedesktop.org/show_bug.cgi?id=20228

[fade-throbber] Draw password dialog even if not animating

If is_animating was not set, the draw would quit before drawing the dialog.

[script] Pass color to the text renderer

We collected the color information before, but did nothing with it.

[label] Add color control

Previously we drew two overlapping labels, one in black and one in white, to
make sure it was vsible on all backgrounds. Now we can pick an appropreate
color for each theme. The default is white. If changing the label color once it
has been shown, it will redraw that part of the screen.

[script] Allow setting the position of the windows

Although the windows are set up to in a reasonable default configuration, the
themes may align the windows differently to not crop some important elements.

The Window.SetX and SetY allow positioning the window anywhere on the canvas.
Use this sparingly as it induces a full refresh of all screens.

If there is a desire to have totally different scenes, the second window can be
positioned somewhere far away so there is overlap and a complete different set
of sprites is used. Another sensible configuration is to have the screens side
by side and allow sprites to span the gap. Remember to create password dialogs
for each screen as not all may be visible.

[script] Handle multiple displays with one script instance

When multiple displays were introduced, each display had its own script plugin
instance. This made things easy as the scripts would not have to be rewritten
for multiple screens. Unfortunately this also meant that each image was loaded
multiple times, and the scripts consumed much more processing power.
Additionally the scripts were not aware of each other.

This patch allows a single script instance to control multiple displays while
maintaining reasonable backward compatibility. All sprites are placed on a
virtual canvas. Displays (or windows) then expose parts of this canvas to the
user.

As a default, window 0 is placed at 0,0. Further windows are placed on top of
the window 0 area matching the centre point so the password dialog (which is
placed in the centre) is visible on all windows. If you target window 0 only
and you place dialogs in the middle of the screen, then everything should work
fine.

Window.GetWidth/GetHeight now takes a window number (if none supplied it will
assume 0). If it replies a NULL, then you accessed beyond the end of the
window set.

[list] Initialise node in the get Nth function

Typo in the previous patch.

[list] Add get Nth node function

Gets the Nth node in the list. If the index is outside the range, it will
return NULL

[list] Add a stable sort

Stable sort sorts but does not change the order of elements which are equal.
This is important in the sprite based plugins where if the level of the sprites
is equal because it may be unimportant which is on top, changing the order
between frames looks bad.

[region] Actually perform the sort when requested

Typo, sort line was missing.

[region] Allow rectangles to be sorted before being fed back

The renderers commit the rectangles derived from the region in a random order.
This gives some tearing as the screen is displayed with a random regions in
their new state. The change sorts the list of rectangles according to their Y
value to commit them from top to bottom. This gives fewer tear lines.

[list] Replace the old sort function with quicksort

It is a simple quicksort implementation which does no randomisation.

[list] Adds tests of the sort function

Sorts 100 random integers. Reports any out of order and returns an error code.

[list] Add test code of the sort function

[branch-merge] Improve plymouth -> X hand off

This merges the "no-fbcon" branch to master.

Previously, the way to get a transition between
plymouth and X was for plymouth to quit,
leaving the tty in KD_GRAPHICS mode, and hope
X starts and picks up the peices.  In this
limbo state where plymouth isn't running but X
isn't started yet the user is unable to
switch VTs or really do anything at all.

If X doesn't start then the user is hosed; they
have to reboot.

Now, instead of quitting plymouth before starting
X we "deactivate" it.  This gets plymouth into a
state where X can take over the display, but
plymouth stays running.  Once X has fully started
up or failed to start the display manager can
tell plymouth to quit (with --retain-splash if
X started successfully and without if X started
unsucessfully)

[client] Add new deactivate subcommand

This tells the daemon we're about to start X with -nr and
to get ready for the transition.

[daemon] deactivate daemon for X transition

In order for plymouth to be able to stay around until
after X is started, we need to put the daemon into a
"deactivated" state where it makes the splash becomes idle
and relinquishes control of the scan out hardware and keyboard
for X to seize.

This commit listens for deactivation requests in the daemon and
performs the deactivation.

A future commit will implement the client bits needed.

[x11] implement new activate/deactivate methods

We disable flushing when inactive.

[frame-buffer] implement new activate/deactivate methods

We basically just do what we were doing before
implicitly on VT switch, explicitly on activate
and deactivate.

[drm] implement new activate/deactivate methods

We basically just do what we were doing before on
implicitly on VT switch, explicitly on activate
and deactivate.

We also don't scan out the splash to the fbcon
on unmap if the renderer is inactive.

[renderer] Add new activate and deactivate methods

The point of these methods are to put the renderer in
and out of a state where it is no longer going to
be on screen.

This should cause flush calls to be no-ops and device
specific locks should be dropped.

These methods will be necessary to keep plymouth running
while X is getting started up.

[main] only set keyboard on splash if available

There may be cases where there is no keyboard set.

[main] make keyboard removal idempotent

[main] drop stray debugging remnant

[script] Remove some debug code

Testing with it replying random strings to make sure the error cases were
caught. Code accidentally left in.

[script] Add string library and the first function "CharAt"

Currently the strings must be manually told to adopt from the library functions
by using String("string").function(). This is temporary and later it should be
possible to apply functions directly to strings.

CharAt gives the a single character string at the index specified. The first
character is at index zero. Characters beyon the end are empty strings, and
errors return NULL. This can be used thusly:

str = "something";
letter = String(str).CharAt(7); # letter = "n"
letter = String(str).CharAt(12); # letter = ""
letter = String(str).CharAt("foo"); # letter = NULL

[script] Use a region to collate all updated areas

Previously, refresh, each sprite would refresh its old area, then its new area.
This, combined with situations where there are many sprites caused the area to
be redrawn many times, each time redrawing each overlapping sprite data.

Now we add all areas which need to be refreshed to a region and this makes a
smaller set of rectangles to refresh, and these are not overlapping.

Also uses the freeze display updates, which should work better now.

[rectangle] Add exact overlap detection

If the width and X position of the two rectangles is the same, we can merge
them together. The new set of exact overlaps detects this and determines the
direction the rectangle should be extended.

The region code now uses this. WARNING, when expanding rectangles, these have
to be merged with the other rectangles down the list as there may be overlap.

[rectangle] Rewrite rectangle_find_overlap function

The previous version had a flaw where it would find the rectangles overlapping
if they spanned a range in one axis. Despite them having no overlap in the
other axis.

Because this version has strange (although correct) behaviour when dealing with
empty rectangles, region only calls the overlap function when both rectangles
are not-empty.

The issue is if an empty rectangle sits on the edge of a full rectangle, the
function reports (possibly correctly) that the edge is overlapped by the empty
rectangle. The region code then nudges the rectangle down one space and
subtracts one from the empty rectangle height. This creates a rectangle with
negative height (bad thing).

If the other version can be fixed I will put it back, but this one is also
useful for the combining two rectangles of equal width.

[region] Remove element only after processing

Now that we cannot rely on the next_node element. We must finish processing the
entry before removing it. Easiest way is to recurse and remove after return.

[region] Break circular dependency using an extra variable

new_area->width depends on new_area->x and vice versa. Break the dependency by
adding a temp variable.

[region] Couple more minor bugs in rectangle merge

Also one redundant line. I think this code was never used in anger. There is a
major bug in the rectangle collision code which makes this detection ad-hoc.

[region] Overlap top right edge lower rectangle starts right of the old

Probably a typo in the original version.

[region] Free rectangle if empty

Previously we just returned and did not free.

[region] Do not prefetch next rectangle node while processing list

If we fetch the next node while working on the current node, recursing down the
list may remove the next node. Just to be double sure, we recurse direct to
next node so the current is not damaged.

[region] Clarify the testing code

The grids show which parts were not covered, or over covered.

[region] Added test program

This examines the behaviour for correct behavious and performance.

[script] Fix typo in SetBackgroundBottomColor function name

This is in the compatibility wrappers so it didn't effect anything..

[x11] Force refresh area to start at 0,0

The x and y values, in area element, were used to determine the position of the
window on the screen. With the x and y not at 0, the full redraw not working
correctly on the second head.

[script] Add text to image capability

Enables scripts to display test by converting it into an image. This can then
be shown using a sprite. Function takes a string and the value of the three
colors (red green blue).

new_image = Image.Text("text we want", 1.0, 0.0, 0.0); // gives red text image

[script] Migrate from image to pixel buffer

The script image is now a pixel buffer. This allows some clever possibilities:
We can now implement text to image.
We can compose images by drawing on them, and record the areas which changed to
avoid refreshing the whole thing.

[pixel-buffer] Move resize and rotate function from image to pixel buffer

There are comparability versions in image, but these are now deprecated.

[image] Allow converting an image to a pixel buffer

A pixel buffer is a much more useful object to manipulate. The image should
only be used when loading from files and never manipulating.

[fade-throbber] Initialise views before animating

Only run the call to animation after all views are initialised. No visible
changes but this is more correct.

[fade-throbber] Move some operations from view to plugin start animation

There were timeouts called once for each view and the first view would cause
is_animating to be set which would stop other views from initialising.

[fade-throbber] Move logo opacity value to individual views

When the logo opacity was plugin wide, one view would change its logo, and the
others would not bother. This prevented the logo form showing up on the second
screen.

[image] Use a pixel buffer to hold the image size and data

The image structure now contains a pixel buffer which holds the data. Some
functions are still within image for compatibility during the migration.

[image] Remove fd from the image structure

The fd element was only used within the load function so did not need to be in
the structure. Also removes the open and close file functions. Their contents
is inlined.
This is the last cleanup before merging with pixel-buffer.

[image] Remove image layout structure

Simplifies the image structure to make it more similar to the pixel-buffer

[image] Remove size from the image structure

Size was never used. Also removes the ply_image_get_size function.
Clean-up in preparation for merging with pixel-buffer.

Revert "[script] free views before nullifying event loop"

This reverts commit a93b6525b3eeab0467bd795fb23fd3d795a90df7.

It has unpleasant side-effects, and the real problem was fixed
in the last view commits.

Analysis from Charlie.

[event-loop] Restart front of pending timeout list after dispatch

This is in case a timeout handler invalidates the list while being
dispatched.

[event-loop] Remove pending timeout before dispatching

This way if the timeout handler removes itself, we don't
double-free and crash.  This is a better fix for

commit 79baa323e61b4c8a0e7bf75c773e78094ebf27fa

Revert "[event-loop] Don't crash by running removed timeouts"

This reverts commit 79baa323e61b4c8a0e7bf75c773e78094ebf27fa.

It wasn't really the right way to fix the original problem.

Now we end up in a case where timeouts can still run after
stop_watching_for_timeout is called on them.  This can cause
crashes.

We need to instead fix the problem in a different way.

[script] free views before nullifying event loop

If we don't do this then a timeout will get scheduled
by view_stop_animation.

[event-loop] add some time out debugging statements

Now we report if code tries to remove a non-existing timeout,
or if there are multiple existing timeouts for the same
handler removed.

[label] Operate with display set to NULL

Performing a ply_label_show with the display set to NULL allows the label to be
drawn any pixel buffer and not perform any redraw events.

[label] Clean up dirty area on change of text or position

When the text or the position is changed, label will call draw events on areas
which were previously drawn on.

The two-step plugin is updated with the new method.

[two-step] Add support for showing message text

Display the message text passed using the message plymouth command. This is
separate from the password prompt text.

[animation] Make sure we do not access frames beyond the end of the animation

Small bug which would try to access the animation frame beyond the end of the
array. Only occurs when doing a redraw after the animation has completed
(e.g. password dialog).

[region] Add missing break statement

This meant that in some cases the region was getting trimmed to
aggresively.

[image] Optimise interpolate and rotate routines.

These are small optimisation to: terminate interpolation early when operating
on fully transparent regions and do rotations by pre-computing the step size
rather than calling cos/sin/atan. These use around 30% fewer instructions on
general images.

Revert "fasdf"

This reverts commit 92dd3083d03608c7dc757b79d532b5f763b006d0.
I have no idea why I commited that or pushed it.

[drm] Don't remove drm fb's that we don't know

When we access to the kernel console's fb, we don't own
it and shouldn't remove it.

Spotted by Scott James Remnant.

[console] Fix ioctl call

it was doing if (!ioctl ... < 0).  Spotted by
Scott James Remnant

[console] remove stray semicolon

fasdf

Force terminal into raw mode on every write call

This is a76c5bc4b74b4f552641ed2fa847f4387163b25a but for
text plugins.

[set-default-theme] Drop nash dependency

Now we require one of

1) /bin/plymouth being installed
2) PLYMOUTH_PLUGIN_PATH being set
3) LIB being set (for compatibility)

[main] Don't add duplicate text display

Before we were adding the same text display once at start up
and once on show splash.

[console] Function in degraded mode when closed

Not all machines will have /dev/tty0.  Those that
don't should still work.

[main] Don't unlink /dev/null

In shutdown mode we were unlinking a file that was set to /dev/null.
Removing /dev/null is a bad idea.

[script] Convert example script functions to use objects

The example script had some old style function names. These still work due to
the compatibility translations, but are not recommended in new code.

[script] Add an "on quit" callback to scripted themes

The callback is called before the final sprite refresh and quit. This allows
the theme to tidy up the screen before handing over to the X fade and the
destop manager.

[text] Don't redraw views after password request

The text plugin doesn't have proper draw handlers at
the moment.  Drawing happens outside of the draw handlers,
and the draw handlers only clear screen.  Don't force
draw_area calls because that clears any drawing.

[script] Sprite and Image objects inherit from an empty scalar

Sprite and Image objects now inherit from an empty scalar which can be used to
keep any random data assoceated with that object. Previously there was a
dangerous tendency to pass any scalar operations to the top inherrited scalar
which was the class prototype.

[script] Change order of spriterefresh operations to remove an incorrect redraw

If a full refresh takes place, the system redraws the whole window but forgets
to remove sprites and update their old positions. The full window refresh is
now done last. Also old_width, and old_height are initialised at sprite
construction.

[main] Truncate output debug file

Truncates the debug file to clear any previous data. Previously, if a run had a
shorter debug data, some data from a previous run would still be present at the
end of the file.

[ daemon ] handle plymouth:force-splash on kernel cmdline

When booting with init=..., plymouthd disables itself. It is problematic
when using bootchartd (bug #22180). plymouth:force-splash allows to
force plymouthd splash.

Ensure init= value is not used when starting plymouthd for shutdown.

[x11] initialize head on query not map

Do it for the same reason we did it in the frame-buffer
plugin in the previous commit.  It's the "right" thing
to do and now that we map lazily, doing it the old way
is broken.

[frame-buffer] initialize head on query not map

That's the "right" thing to do and now that we
map lazily, doing it the old way is broken.

[renderer] map buffer lazily

This is to prevent screen clears on plugins that don't
use the renderers (text plugins)

[renderer] make map and unmap idempotent

[keyboard] make stop_watching_for_terminal_input idempotent