openlp
/
documentation
mirror of https://gitlab.com/openlp/documentation.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

head

This commit is contained in:
Wesley Stout 2012-06-13 09:08:17 -05:00
parent 94dcce621e df5e108eff
commit f3260808be
3 changed files with 401 additions and 345 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

744
manual/source/install_linux.rst
View File

@ -1,344 +1,400 @@
Installing OpenLP on Linux
==========================
Setting up OpenLP varies by distribution. We have included documentation on
popular distributions or distributions that have OpenLP available from their
package managers. It should be possible to get OpenLP running on
nearly any Linux distribution.
Ubuntu
^^^^^^
Installation of OpenLP on Ubuntu can either be done through the Software Center
or the command line. Command line instructions will be included at the end of
this section on Ubuntu and its variants.
Open up the software center by clicking on the :guilabel:`Software Center` icon
in the Launcher if you are using the Unity desktop, or if you are using an
older version of Ubuntu, or the Classic Desktop go to :menuselection:`Applications`
and select the Software Center from the bottom of the menu. You will need to
be the administrator of the system to install OpenLP and will be asked for the
administrator password several times through this process.
First you will need to add the OpenLP Personal Package Archive (PPA) to
your system. Go to :menuselection:`Edit --> Software Sources`
.. image:: pics/1softwaresources.png
Click on the :menuselection:`Other Software` tab then click on the
:guilabel:`Add...` button to add the new software source.
.. image:: pics/2othersoftware.png
Add the APT line::
ppa:openlp-core/release
Click :guilabel:`Add Source`
.. image:: pics/3aptline.png
You now need to restart the Software Center to refresh the package list. When
you have the Software Center running simply search for OpenLP and click
:guilabel:`Install`.
.. image:: pics/4searchopenlp.png
You will see the install progress as OpenLP and the dependencies required for
it to run are downloaded.
.. image:: pics/5installprogressubuntu.png
After installation you should see that OpenLP is installed.
.. image:: pics/6installcompleteubuntu.png
You can now run OpenLP by either searching for it in the *Dash*, or clicking on
the category *Media Apps* in Unity. If you are running the Classic Desktop you
will have OpenLP available by clicking
:menuselection:`Applications --> Sound and Video --> OpenLP`
Kubuntu
^^^^^^^
From the KickOff Menu click :guilabel:`System Settings` Then click on
:guilabel:`Software Management`.
.. image:: pics/kubuntusystemsettings.png
Click on settings in the left hand column.
.. image:: pics/kubuntugetremovesoftware.png
Click on the :guilabel:`Edit Origins` button.
.. image:: pics/kubuntuaddremovesettings.png
Click on the :guilabel:`Other Software` tab.
.. image:: pics/kubuntusoftwaresources.png
Click the :guilabel:`Add` button.
.. image:: pics/kubuntuothersoftware.png
Type the following in the text box::
ppa:openlp-core/release
.. image:: pics/kubuntuaddapt.png
After clicking :guilabel:`OK` you should now see new entries for OpenLP
.. image:: pics/kubuntusoftwareopenlpadded.png
Click :guilabel:`Close` when given the option to reload the software
information click the :guilabel:`Reload` button.
.. image:: pics/kubuntureloadsources.png
Click on :guilabel:`Get and Remove Software` in the left column. Type openlp in
the search box. Next, click on :guilabel:`Find by name`. Once OpenLP is located
click on the search result and click on :guilabel:`Install`. Click the
:guilabel:`Apply` button to install OpenLP
.. image:: pics/kubuntuopenlpsearch.png
You should now see the progress of the download.
.. image:: pics/kubuntudownloadprogress.png
Once completed you may have the option to start OpenLP from the window pictured
below. If this feature is not enabled, you can start OpenLP from the KickOff
menu.
.. image:: pics/kubuntuopenlplaunch.png
Ubuntu Command Line Install
^^^^^^^^^^^^^^^^^^^^^^^^^^^
The following install procedure should work across all Ubuntu variants. You
will need to add the Personal Package Archive (PPA) to Ubuntu's software
sources. From a terminal type::
user@ubuntu:~$ sudo add-apt-repository ppa:openlp-core/release
Now you need to refresh the package list::
user@ubuntu:~$ sudo apt-get update
Install OpenLP::
user@ubuntu:~$ sudo apt-get install openlp
OpenLP should now be available in your desktop's menu system, but if you wish
to run OpenLP from the command line type::
user@ubuntu:~$ openlp
Fedora (GNOME)
^^^^^^^^^^^^^^
**Note** When installing OpenLP you will need to have administrator privileges.
You will be asked for the administrator password to install.
Installing with Fedora you will use the default Add/Remove Programs available
from :menuselection:`System --> Administration --> Add/Remove Programs` in
Fedora 14 and below or in :menuselection:`Applications --> System Tools -->
Add/Remove Programs`
.. image:: pics/1fedoraaddremove.png
Search for OpenLP in the search box
.. image:: pics/2fedoraaddremove.png
Check the check box for OpenLP then click :guilabel:`Apply`
.. image:: pics/3fedoraaddremove.png
Click :guilabel:`Continue` to confirm installing any additional software.
.. image:: pics/4fedoraadditionalconfirm.png
You should now see the packages downloading in the lower left corner.
.. image:: pics/5fedoraaddremove.png
Click :guilabel:`Run` to run OpenLP now, or :guilabel:`Close` to run OpenLP
later.
.. image:: pics/6fedoracomplete.png
OpenLP will be available in :menuselection:`Applications --> Sound & Video --> OpenLP`
Fedora (KDE)
^^^^^^^^^^^^
**Note** when installing OpenLP you will need to have administrator privileges.
You will be asked for the administrator password to install.
From the KickOff open *Software Management*. Type OpenLP into the search
box. Then click :guilabel:`Find by name` or press :kbd:`Enter`.
.. image:: pics/1fedoragetremove.png
Select OpenLP from the search results. Next, click :guilabel:`Apply`
.. image:: pics/2fedoragetremove.png
Now give permission to install other software dependencies that are needed by
clicking :guilabel:`Continue`
.. image:: pics/3fedoraadditionalchanges.png
Once completed you can run OpenLP by clicking on its logo in the completed
install notification, or from the KickOff menu.
.. image:: pics/4fedoracompleted.png
Fedora Command Line Install
^^^^^^^^^^^^^^^^^^^^^^^^^^^
To install OpenLP from the command line type::
user@fedora:~$ sudo yum install openlp
OpenLP should now be available in your desktop's menu system, but if you wish
to run OpenLP from the command line type::
user@fedora:~$ openlp
Linux Mint
^^^^^^^^^^
The following instructions are for a standard Linux Mint install. These
instructions will not work with Linux Mint Debian Edition. If your are running
Linux Mint without the standard desktop please see the :ref:`mint-command`
install instructions.
The administrator password will be required several times during the
installation. To install OpenLP open the Software Manager from the Mint Menu.
.. image:: pics/mint1.png
The OpenLP personal package archive (PPA) will need to be added. Click on
:menuselection:`Edit --> Software Sources`
.. image:: pics/mint2.png
Click on the :guilabel:`Other Software` tab.
.. image:: pics/mint3.png
Click on the :guilabel:`Add...` button to add the new software source.
.. image:: pics/mint4.png
Add the APT line::
ppa:openlp-core/release
Click :guilabel:`Add Source`.
.. image:: pics/mint5.png
Click :guilabel:`Reload` to reload your software sources.
.. image:: pics/mint6.png
Type OpenLP into the search box to locate the OpenLP package.
.. image:: pics/mint7.png
Click on OpenLP from the results then click :guilabel:`Install`.
.. image:: pics/mint8.png
After OpenLP is installed you can close the Software Manager and start OpenLP
from the *Sound and Video* section of the Mint Menu.
.. _mint-command:
Linux Mint Command Line Install
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You will need to add the Personal Package Archive (PPA) to Linux Mint's
software sources. From a terminal type::
user@mint:~$ sudo add-apt-repository ppa:openlp-core/release
Now you need to refresh the package list::
user@mint:~$ sudo apt-get update
Install OpenLP::
user@mint:~$ sudo apt-get install openlp
OpenLP should now be available in your desktop's menu system, but if you wish
to run OpenLP from the command line type::
user@mint:~$ openlp
openSUSE
^^^^^^^^
OpenLP is available using 1-Click Install on the openSUSE Build Service
website. Go to the `openSUSE Build Service site <http://software.opensuse.org>`_
and type :kbd:`openlp` into the search box.
.. image:: pics/suse1.png
Then click :guilabel:`1-Click Install`
.. image:: pics/suse2.png
Select :guilabel:`Open with YaST 1-Click Install` then click :guilabel:`OK`
.. image:: pics/suse3.png
Additional repositories may need to be enabled. This will be performed
automatically. Accept the default options by clicking :guilabel:`Next`
.. image:: pics/suse5.png
Confirm you want to install OpenLP and click :guilabel:`Next`
.. image:: pics/suse6.png
Before the installation takes place confirm adding the repositories and
installing the software again. Click :guilabel:`Next` to continue.
.. image:: pics/suse7.png
Since this is a third party application the software key will have to be
accepted. Click :guilabel:`Trust` to accept the software key.
.. image:: pics/suse8.png
OpenLP will now be installed. When the install process is completed click
:guilabel:`Finish`.
.. image:: pics/suse9.png
OpenLP will now be available for use.
Arch Linux
^^^^^^^^^^
OpenLP is availabe on Arch Linux through the Arch User Repository, or AUR. Info
on the AUR can be found `at the Arch wiki <https://wiki.archlinux.org/index.php/Arch_User_Repository>`_.
There are a variety of tools and methods to install from the AUR. For this
example we will demonstrate using Yaourt. For more info on Yaourt please see
the `Yaourt documentation <https://wiki.archlinux.org/index.php/Yaourt>`_.
From a terminal type::
user@arch:~$ yaourt -S openlp
OpenLP should now be available in your desktop's menu system, but if you wish
to run OpenLP from the command line type::
user@arch:~$ openlp
Installing OpenLP on Linux
==========================
Setting up OpenLP varies by distribution. We have included documentation on
popular distributions or distributions that have OpenLP available from their
package managers. It should be possible to get OpenLP running on
nearly any Linux distribution.
Ubuntu
----------------
Installation of OpenLP on Ubuntu can either be done through the Software Center
or the command line. Command line instructions will be included at the end of
this section on Ubuntu and its variants.
Ubuntu 12.04 or later
^^^^^^^^^^^^^^^^^^^^^^^^^
If you are using Ubuntu 12.10 or a more recent version then OpenLP is
included in the standard distribution. If you are using Ubuntu 12.04 then
OpenLP has been added to the backports packages and so is available
with the appropriate setting below.
Open up the software center by clicking on the :guilabel:`Software Center` icon
in the Launcher if you are using the Unity desktop, or if you are using an
older version of Ubuntu, or the Classic Desktop go to :menuselection:`Applications`
and select the Software Center from the bottom of the menu. You will need to
be the administrator of the system to install OpenLP and will be asked for the
administrator password several times through this process.
If using Ubuntu 12.04 then when you have the Software Center running you need to
turn on support for backports. From the menu choose Edit/Software Sources and
then the "Updates" tab. Now make sure that "Unsupported Updates
(precise-backports) is ticked. Then click :guilabel:`close`.
.. image:: pics/ubuntu-backports.png
Next in any of these versions simply search for OpenLP in the Software Center
and click :guilabel:`Install`.
.. image:: pics/4searchopenlp.png
You will see the install progress as OpenLP and the dependencies required for
it to run are downloaded.
.. image:: pics/5installprogressubuntu.png
After installation you should see that OpenLP is installed.
.. image:: pics/6installcompleteubuntu.png
You can now run OpenLP by either searching for it in the *Dash*, or clicking on
the category *Media Apps* in Unity. If you are running the Classic Desktop you
will have OpenLP available by clicking
:menuselection:`Applications --> Sound and Video --> OpenLP`
Ubuntu older than 12.04
^^^^^^^^^^^^^^^^^^^^^^^^
In older versions of Ubuntu you will first need to add the
OpenLP Personal Package Archive (PPA) to your system.
Open up the software center using :menuselection:`Applications`
and select the Software Center from the bottom of the menu. You will need to
be the administrator of the system to install OpenLP and will be asked for the
administrator password several times through this process.
Then go to :menuselection:`Edit --> Software Sources`
.. image:: pics/1softwaresources.png
Click on the :menuselection:`Other Software` tab then click on the
:guilabel:`Add...` button to add the new software source.
.. image:: pics/2othersoftware.png
Add the APT line::
ppa:openlp-core/release
Click :guilabel:`Add Source`
.. image:: pics/3aptline.png
You now need to restart the Software Center to refresh the package list. When
you have the Software Center running simply search for OpenLP and click
:guilabel:`Install`.
.. image:: pics/4searchopenlp.png
You will see the install progress as OpenLP and the dependencies required for
it to run are downloaded.
.. image:: pics/5installprogressubuntu.png
After installation you should see that OpenLP is installed.
.. image:: pics/6installcompleteubuntu.png
You can now run OpenLP by either searching for it in the *Dash*, or clicking on
the category *Media Apps* in Unity. If you are running the Classic Desktop you
will have OpenLP available by clicking
:menuselection:`Applications --> Sound and Video --> OpenLP`
Kubuntu
-------
From the Kickoff Menu click :guilabel:`System Settings` Then click on
:guilabel:`Software Management`.
.. image:: pics/kubuntusystemsettings.png
Click on settings in the left hand column.
.. image:: pics/kubuntugetremovesoftware.png
Click on the :guilabel:`Edit Origins` button.
.. image:: pics/kubuntuaddremovesettings.png
Click on the :guilabel:`Other Software` tab.
.. image:: pics/kubuntusoftwaresources.png
Click the :guilabel:`Add` button.
.. image:: pics/kubuntuothersoftware.png
Type the following in the text box::
ppa:openlp-core/release
.. image:: pics/kubuntuaddapt.png
After clicking :guilabel:`OK` you should now see new entries for OpenLP
.. image:: pics/kubuntusoftwareopenlpadded.png
Click :guilabel:`Close` when given the option to reload the software
information click the :guilabel:`Reload` button.
.. image:: pics/kubuntureloadsources.png
Click on :guilabel:`Get and Remove Software` in the left column. Type openlp in
the search box. Next, click on :guilabel:`Find by name`. Once OpenLP is located
click on the search result and click on :guilabel:`Install`. Click the
:guilabel:`Apply` button to install OpenLP
.. image:: pics/kubuntuopenlpsearch.png
You should now see the progress of the download.
.. image:: pics/kubuntudownloadprogress.png
Once completed you may have the option to start OpenLP from the window pictured
below. If this feature is not enabled, you can start OpenLP from the Kickoff
menu.
.. image:: pics/kubuntuopenlplaunch.png
Ubuntu Command Line Install
---------------------------
If you are using Ubuntu 12.10 or a more recent version then OpenLP is included
in the standard distribution. To Install OpenLP open a terminal and type::
user@ubuntu:~$ sudo apt-get install openlp
OpenLP should now be available in your desktop's menu system, but if you wish
to run OpenLP from the command line type::
user@ubuntu:~$ openlp
If you are using an older Ubuntu that does not include OpenLP in the standard
distribution then the following install procedure should work across all Ubuntu
variants. First you will need to add the Personal Package Archive (PPA) to
Ubuntu's software sources. From a terminal type::
user@ubuntu:~$ sudo add-apt-repository ppa:openlp-core/release
Now you need to refresh the package list::
user@ubuntu:~$ sudo apt-get update
Install OpenLP::
user@ubuntu:~$ sudo apt-get install openlp
OpenLP should now be available in your desktop's menu system, but if you wish
to run OpenLP from the command line type::
user@ubuntu:~$ openlp
Fedora (GNOME)
--------------
**Note** When installing OpenLP you will need to have administrator privileges.
You will be asked for the administrator password to install.
Installing with Fedora you will use the default Add/Remove Programs available
from :menuselection:`System --> Administration --> Add/Remove Programs` in
Fedora 14 and below or in :menuselection:`Applications --> System Tools -->
Add/Remove Programs`
.. image:: pics/1fedoraaddremove.png
Search for OpenLP in the search box
.. image:: pics/2fedoraaddremove.png
Check the check box for OpenLP then click :guilabel:`Apply`
.. image:: pics/3fedoraaddremove.png
Click :guilabel:`Continue` to confirm installing any additional software.
.. image:: pics/4fedoraadditionalconfirm.png
You should now see the packages downloading in the lower left corner.
.. image:: pics/5fedoraaddremove.png
Click :guilabel:`Run` to run OpenLP now, or :guilabel:`Close` to run OpenLP
later.
.. image:: pics/6fedoracomplete.png
OpenLP will be available in :menuselection:`Applications --> Sound & Video --> OpenLP`
Fedora (KDE)
------------
**Note** when installing OpenLP you will need to have administrator privileges.
You will be asked for the administrator password to install.
From the Kickoff open *Software Management*. Type OpenLP into the search
box. Then click :guilabel:`Find by name` or press :kbd:`Enter`.
.. image:: pics/1fedoragetremove.png
Select OpenLP from the search results. Next, click :guilabel:`Apply`
.. image:: pics/2fedoragetremove.png
Now give permission to install other software dependencies that are needed by
clicking :guilabel:`Continue`
.. image:: pics/3fedoraadditionalchanges.png
Once completed you can run OpenLP by clicking on its logo in the completed
install notification, or from the Kickoff menu.
.. image:: pics/4fedoracompleted.png
Fedora Command Line Install
---------------------------
To install OpenLP from the command line type::
user@fedora:~$ sudo yum install openlp
OpenLP should now be available in your desktop's menu system, but if you wish
to run OpenLP from the command line type::
user@fedora:~$ openlp
Linux Mint
----------
The following instructions are for a standard Linux Mint install. These
instructions will not work with Linux Mint Debian Edition. If your are running
Linux Mint without the standard desktop please see the :ref:`mint-command`
install instructions.
The administrator password will be required several times during the
installation. To install OpenLP open the Software Manager from the Mint Menu.
.. image:: pics/mint1.png
The OpenLP personal package archive (PPA) will need to be added. Click on
:menuselection:`Edit --> Software Sources`
.. image:: pics/mint2.png
Click on the :guilabel:`Other Software` tab.
.. image:: pics/mint3.png
Click on the :guilabel:`Add...` button to add the new software source.
.. image:: pics/mint4.png
Add the APT line::
ppa:openlp-core/release
Click :guilabel:`Add Source`.
.. image:: pics/mint5.png
Click :guilabel:`Reload` to reload your software sources.
.. image:: pics/mint6.png
Type OpenLP into the search box to locate the OpenLP package.
.. image:: pics/mint7.png
Click on OpenLP from the results then click :guilabel:`Install`.
.. image:: pics/mint8.png
After OpenLP is installed you can close the Software Manager and start OpenLP
from the *Sound and Video* section of the Mint Menu.
.. _mint-command:
Linux Mint Command Line Install
-------------------------------
You will need to add the Personal Package Archive (PPA) to Linux Mint's
software sources. From a terminal type::
user@mint:~$ sudo add-apt-repository ppa:openlp-core/release
Now you need to refresh the package list::
user@mint:~$ sudo apt-get update
Install OpenLP::
user@mint:~$ sudo apt-get install openlp
OpenLP should now be available in your desktop's menu system, but if you wish
to run OpenLP from the command line type::
user@mint:~$ openlp
openSUSE
--------
OpenLP is available using 1-Click Install on the openSUSE Build Service
website. Go to the `openSUSE Build Service site <http://software.opensuse.org>`_
and type :kbd:`openlp` into the search box.
.. image:: pics/suse1.png
Then click :guilabel:`1-Click Install`
.. image:: pics/suse2.png
Select :guilabel:`Open with YaST 1-Click Install` then click :guilabel:`OK`
.. image:: pics/suse3.png
Additional repositories may need to be enabled. This will be performed
automatically. Accept the default options by clicking :guilabel:`Next`
.. image:: pics/suse5.png
Confirm you want to install OpenLP and click :guilabel:`Next`
.. image:: pics/suse6.png
Before the installation takes place confirm adding the repositories and
installing the software again. Click :guilabel:`Next` to continue.
.. image:: pics/suse7.png
Since this is a third party application the software key will have to be
accepted. Click :guilabel:`Trust` to accept the software key.
.. image:: pics/suse8.png
OpenLP will now be installed. When the install process is completed click
:guilabel:`Finish`.
.. image:: pics/suse9.png
OpenLP will now be available for use.
Arch Linux
----------
OpenLP is available on Arch Linux through the Arch User Repository, or AUR. Info
on the AUR can be found `at the Arch wiki <https://wiki.archlinux.org/index.php/Arch_User_Repository>`_.
There are a variety of tools and methods to install from the AUR. For this
example we will demonstrate using Yaourt. For more info on Yaourt please see
the `Yaourt documentation <https://wiki.archlinux.org/index.php/Yaourt>`_.
From a terminal type::
user@arch:~$ yaourt -S openlp
OpenLP should now be available in your desktop's menu system, but if you wish
to run OpenLP from the command line type::
user@arch:~$ openlp

2
manual/source/introduction.rst
View File

@ -5,7 +5,7 @@ Introduction
About
-----
OpenLP stands for "Open Source Lyrics Projection" and is presentation software
OpenLP stands for "Open Lyrics Projection" and is presentation software
developed for churches to provide a single easy to use interface for the
projection needs of a typical worship service. First created in 2004, it has
steadily grown in features and maturity such that it is now a mainstay in

BIN
manual/source/pics/ubuntu-backports.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 57 KiB