French

Makagiga - README

Table of Contents

What is Makagiga?

To-do manager, RSS reader, notepad, widgets, image viewer...

Makagiga is a free, easy-to-use, cross-platform application for doing a variety of tasks, such as text editing, todo listing, RSS reading, and simple image viewing. Plugins are used to implement its various capabilities. It can perform file import/export, backing up files, Internet searching (Google, Wikipedia), and more.

Requirements

Makagiga requires Java Runtime Environment ("Java") compatible with Sun Java(tm) Standard Edition (1.)6.0 (aka Java SE 6). Currently only Linux and Windows 200x/XP are officially supported by the Makagiga project. However, you can try to run Makagiga on the following platforms: MacOS X, Solaris, Windows 9x, ... You can check your current Java version online.

Installation

Note: Exit Makagiga before you start the installation.

Java Installation

Generic

  1. Download Java Runtime Environment (JRE) for your operating system

Ubuntu/Kubuntu

  1. Run sudo apt-get install sun-java6-jre to install Java Runtime Environment (this command requires administrator password)
  2. If you want to compile Makagiga from sources, or develop plugins, you must also run sudo apt-get install sun-java6-jdk ant gettext doxygen. This will install Java Development Kit (compilator), Ant (like "make"), Gettext Utilities (required to build language translations), and Doxygen (API documentation generator). You may also want to install free NetBeans IDE...

Debian/Ubuntu package - *.deb file

  1. Run sudo dpkg -i makagiga-YOUR_VERSION.deb to install (requires administrator password)
  2. Run sudo dpkg -r makagiga to uninstall

RPM package - *.rpm file

  1. Run su -c "rpm -Uvh makagiga-YOUR_VERSION.rpm" to install (requires administrator password)
  2. Run su -c "rpm -e makagiga" to uninstall

Zipped package - *.zip file

  1. Unpack: unzip makagiga-YOUR_VERSION.zip
  2. Change directory: cd makagiga-YOUR_VERSION
  3. ...run: ./run.sh
  4. ...or install: ./install.sh
  5. The application will be installed in the /usr/local (default prefix) directory. To change the installation directory, use the following command: ./install.sh /my_prefix/my_apps.
  6. Run YOUR_PREFIX/makagiga/uninstall.sh, to uninstall

Setup file - *.exe file

Run makagiga-YOUR_VERSION.exe to install. Use Control Panel to uninstall.

How to run? (Linux)

  1. METHOD #1: Run the makagiga command
  2. METHOD #2: Select the Makagiga command from the KDE/GNOME menu (Office section)

Configuration

Portable Application

Since version 1.9.1 Beta you can launch Makagiga directly from a writeable and removable storage device (USB flash drive or flash card). To do this simply unzip makagiga-VERSION.zip file, then launch run-portable.exe / run-portable.bat (Windows) or run-portable.sh (Linux). All data files will be stored in the same directory where Makagiga was unzipped. If everything is OK, you should notice "[Portable]" text in the main window title.

Profiles

To start with custom profile, you need to use --profile command line option, or the MAKAGIGA_PROFILE environment variable. Note that the "Profile Name" is a directory name, so it cannot contain "/", "\", "." or any other illegal characters. All profiles are stored in the user's home directory (e.g. ~/.makagiga/profiles).

Example 1: makagiga --profile "Profile Name"

Example 2: export MAKAGIGA_PROFILE="Profile Name"; makagiga

To change directory with user files, you need to use --user-files command line option, or the MAKAGIGA_USER_FILES environment variable. The "User Files" directory must already exist.

Example 1: makagiga --user-files "/home/foo/Makagiga"

Example 2: export MAKAGIGA_USER_FILES="/home/foo/Makagiga"; makagiga

Note: You cannot use both --profile and --user-files options.

Command Line Options

Run makagiga --help to display this list:

--autostart     Start application in minimized or hidden window
--full-screen   Start application in full screen window
--portable      Use this option if application is stored on a writeable and removable
                storage device (USB flash drive or flash card)
--presentation  Start application in full screen "presentation" mode
--profile       Start with profile. Example: --profile "Profile Name"
--safe-mode     Run application in safe mode
--user-files    Directory with configuration and data files.
                Example: --user-files "/home/foo/Makagiga"
--version       Show version info and exit

License & Copyright

Makagiga - Copyright 2005 Konrad Twardowski
Image Filters - Copyright 2006 Jerry Huxtable

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.


MiGBase64 - A high performance base64 codec
Copyright (c) 2004, Mikael Grev, MiG InfoCom AB. (base64 @ miginfocom . com)
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or other
materials provided with the distribution.
Neither the name of the MiG InfoCom AB nor the names of its contributors may be
used to endorse or promote products derived from this software without specific
prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.


Artwork


Makagiga Logo by MaƂgorzata Kiszka


The Oxygen Icon Theme
Creative Common Attribution-ShareAlike 3.0 license
or the GNU Library General Public License (with following clarification):

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA  02110-1301 USA

Clarification:

  The GNU Lesser General Public License or LGPL is written for
  software libraries in the first place. We expressly want the LGPL to
  be valid for this artwork library too.

  KDE Oxygen theme icons is a special kind of software library, it is an
  artwork library, it's elements can be used in a Graphical User Interface, or
  GUI.

  Source code, for this library means:
   - where they exist, SVG;
   - otherwise, if applicable, the multi-layered formats xcf or psd, or
  otherwise png.

  The LGPL in some sections obliges you to make the files carry
  notices. With images this is in some cases impossible or hardly useful.

  With this library a notice is placed at a prominent place in the directory
  containing the elements. You may follow this practice.

  The exception in section 6 of the GNU Lesser General Public License covers
  the use of elements of this art library in a GUI.

  kde-artists [at] kde.org



"Emotion" Icon Set by Yellowicon Studio
www.everaldo.com
www.yellowicon.com


Old Icon Theme
by Everaldo Coelho
and the KDE Team


Duke: The Java Mascot
Berkeley Software Distribution (BSD) License


Desklet Icon
The Glossitope Team


SourceForge.net Logo
(C) SourceForge, Inc.

(C) 2005-3000 Konrad Twardowski