From ac36e94341ca73d581f0df39f1c7bbf2138b2845 Mon Sep 17 00:00:00 2001 From: Frederic Culot Date: Mon, 31 Jul 2006 21:00:02 +0000 Subject: Initial revision --- doc/manual_de.html | 728 +++++++++++++++++++++++++++++++++++++++++++ doc/manual_en.html | 783 ++++++++++++++++++++++++++++++++++++++++++++++ doc/manual_fr.html | 898 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 2409 insertions(+) create mode 100755 doc/manual_de.html create mode 100755 doc/manual_en.html create mode 100755 doc/manual_fr.html (limited to 'doc') diff --git a/doc/manual_de.html b/doc/manual_de.html new file mode 100755 index 0000000..1568096 --- /dev/null +++ b/doc/manual_de.html @@ -0,0 +1,728 @@ + + + + + +CALCURSE documentation + + + + +

CALCURSE - textbasierender Terminkalender

+

+

+ +

Inhaltsverzeichnis

+ +

+ + +

Einleitung

+

+calcurse ist ein textbasierender persönlicher Terminkalender, der +Ihnen bei der Organisation von Terminen und täglichen Aufgaben +hilft. Er beinhaltet einen Kalender sowie eine 'todo'-Liste, die Ihre +Termine ordnet. Das Benutzer-Interface ist einstellbar. Terminalfarben +und Layout lassen sich individuell anpassen. Alle Kommandos sind +dokumentiert und können zur Laufzeit jederzeit erfragt werden. + + +

Überblick

+

Anlass

+

+Nachdem ich mein Diplom in Astrophysik absolviert hatte, kam mir die +Idee dieses Programm zu schreiben. Alles begann etwas unorganisiert zu +werden. Ein Programm, dass mir bei meiner Terminplanung etwas hilft, +war wirklich vonnöten. ;)
+Ich mag Programme mit Textinterfaces, weil sie einfach, schnell, +portabel und effizient sind. Also dachte ich darüber nach ein +Programm mit textorientiertem Benutzer-Interface zu entwickeln. +Darüber hinaus wollte ich meine Kenntnisse in der Programmiersprache +C erweitern. Im Grundstudium kam ich mit C +erstmals in Kontakt. Ich denke es ist eine gute Idee ein solches +Projekt zu beginnen und dabei meine Kenntnisse in C zu +erweitern! Mein Diplom habe ich nun absolviert, calcurse +ist aber noch immer nicht fertig. Nach wie vor entwickle ich dieses +Programm weiter, in der Hoffnung, dass es für andere von Nutzen sein +wird. Also hier ist es...
+
+Doch warum nenne ich es 'calcurse'? Nun, es ist einfach +zusammengesetzt aus den Wörtern 'CALendar' und 'nCurses', dem Namen +der Bibliothek die für das Benutzer-Interface verwendet wird. + + +

Wichtige Eigenschaften

+

+Calcurse ist portabel und setzt sich zum Ziel klein, +schnell und sicher zu sein. Es ist auf einer Konsole oder einem +Terminal zu verwenden, entweder lokal oder auf einem entfernten System +mithilfe einer ssh-Verbindung (oder ähnlichem).
+Calcurse kann in zwei unterschiedlichen Modi gestartet +werden: ein interaktiver und nicht-interaktiver Modus. Der erste Modus +erzeugt Dank des textbasierenden Interfaces die Ansicht eines eigenen +persönlichen Terminkalenders. Mit dem zweiten Modus ist es möglich +sich ein Erinnerungstool (Reminder) zu erstellen, wenn +calcurse mit den entsprechenden Argumenten in 'cron tab' +oder einem 'init script' eingebunden wird.
+Darüber hinaus ist calcurse für Benutzer erstellt worden, +mit der Absicht so benutzerfreundlich wie möglich zu sein. Das +bedeutet, dass eine komplette Onlinehilfe im Programm zu Verfügung +steht, sowie alle mögliche Aktionen zu jeder Zeit in einer Statuszeile +ersichtlich sind. Das Benutzer-Interface ist ebenfalls +einstellbar. Ebenso kann man verschiedene Textfarben und Layouts +wählen. + + +

Installation

+

Voraussetzungen

+

ncurses Bibliothek

+

+Calcurse benötigt einen C-Compiler wie etwa +cc oder gcc. Ferner wird die +ncurses-Bibliothek benötigt, dass aber auf den meisten Unix-Systemen +verfügbar sein sollte. Falls nicht, kann es von folgender URL herunter +laden:
+

+                http://ftp.gnu.org/pub/gnu/ncurses/
+
+ +

gettext Bibliothek

+

+ + calcurse unterstützt die Internationalisierung + (künftig i18n) durch gettext. + Das bedeutet, dass calcurse mehrsprachige Mitteilungen + erzeugen kann, wenn es mit der entsprechenden Sprachunterstützung + kompiliert wurde (z.B. NLS). + Dennoch, NLS ist optional und wenn keine mehrsprachigen Mitteilungen + gewünscht sind, kann diese Eigenschaft abgestellt werden. Einfach die Option --disable-nls dem configure Skript übergeben + (siehe Abschnitt Installationsprozess).
+ Um zu überprüfen, ob gettext auf dem System installiert ist, + kann man nach der libintl.h Datei suchen: + 

+                locate libintl.h
+
+ Wenn diese Datei nicht gefunden wird, kann gettext von folgender URL herunter geladen werden:
+ 
+                 http://ftp.gnu.org/pub/gnu/gettext/
+
+ Beachte: Auch wenn libintl.h auf dem System + gefunden wurde, kann es erforderlich sein den Pfad dieser Datei während des Installationsprozesses anzugeben. Die entsprechende + Option für das configure Skript lautet dann --with-libintl-prefix. + Das configure Skript wird natürlich vorzeitig abbrechen, wenn die dazugehörige Bibliothek nicht gefunden wurde. + + +

Installationsprozess

+

+Als erstes müssen die Dateien entpackt werden: +

+        tar zxvf calcurse-1.4.tar.gz
+
+Wenn Sie die Voraussetzungen erfüllen und das Archiv entpackt +vorliegen, sind nur noch die drei üblichen Schritte erforderlich: +
    +
  1. ./configure +
  2. make +
  3. make install (mit Root-Rechten) +
+Benutzen Sie ./configure --help um eine Liste mit den +verfügbaren Optionen zu erhalten. + + +

calcurse Grundlagen

+

Programmaufruf

+

Programmargumente

+

+Calcurse kann mit folgenden Optionen aufgerufen werden: + +

+
-a +
Gibt die Termine eines anzugebenen Tags aus.
+Beachte: Die Kalender-Datei, von der die Termine gelesen +werden sollen, kann mit mithilfe der -c Option angegeben werden.
+
+
-c +
+Gibt die zu lesende Kalender-Datei an.
+Der Standardkalender ist ~/.calcurse/apts (beachte auch +Abschnitt: calcurse Dateien).
+
+
-d +
+Gibt die Termine eines angegebenen Datums aus oder gibt alle Termine +der anzugebenen nachfolgenden Tage aus. Somit sind zwei mögliche +Formate möglich: +
    +
  • Datum: 'MM/TT/JJJJ' (Monat, Tag, Jahr). +
  • Anzahl der Tage: 'n'. +
+Im ersten Fall wird eine Liste mit allen Terminen des anzugebenen +Datums ausgegeben. Der zweite Fall listet alle folgenden Termine auf, +die in den nächsten 'n' Tagen zu erledigen sind.
+Beispiel: die Eingabe calcurse -d 3 gibt alle Termine von +heute, morgen und übermorgen aus.
+
+
-h +
+Gibt eine Hilfe zu den Unterstützten Optionen aus.
+
+
-t +
+Gibt die 'todo' Liste aus.
+
+
-v +
+Gibt die aktuelle Version von Calcurse aus. +
+ + +

Umgebungsvariable für i18n

+

+ + calcurse kann mit einer Unterstützung für die Muttersprache + kompiliert werden (siehe gettext + Bibliothek). Wenn Meldungen in der Muttersprache gewünscht sind, + sollte zunacht geprüft werden, ob die po/LINGUAS Datei verfügbar ist. + Diese Datei zeigt alle verfügbaren Sprachen durch + zweibuchstabige Kürzel an (z. B., fr + steht für französisch). Wenn Ihre Sprache nicht aufgeführt ist, wäre es + natürlich grossartig, wenn Sie sich an der Übersetzung von calcurse + in andere Sprachen beteiligen könnten (siehe Abschnitt Wie kann + ich einen Beitrag leisten?).
+ Wenn Ihre Sprache verfügbar ist, starten Sie + calcurse mit dem folgenden Aufruf: + 

+                LC_ALL=fr_FR calcurse
+
+ wobei fr_FR der Name der gewünschten Spracheausgabe ist und durch + das Kürzel Ihrer Sprache ersetzt werden kann. + + +

Benutzer-Interface

+

Nicht interaktiver Modus

+

+Wird calcurse mit den Optionen:
+-a, -d, -t, +-h, -v
+gestartet, wird das Programm im nicht-interaktiven Modus +ausgeführt. Das bedeutet, dass die gewünschten Informationen +ausgegeben werden und das Programm anschließend sofort wieder beendet +wird. So ist es möglich mit dem Aufruf calcurse -ta eine +Liste aller Termine eines bestimmten Tages zu erhalten. + + +

Interaktiver Modus

+

+Ohne Angabe einer Option oder nur die Option -c startet +calcurse im interaktiven Modus. In diesem Modus erhält +man ein Interface mit drei unterschiedlichen Panels, die mit der +'TAB'-Taste angesteuert werden können, sowie eine Status-Zeile (siehe +unten). +

+
+      Termin-Panel---.                                   .---Kalender-Panel
+                     |                                   |
+                     v                                   v
+ +------------------------------------++----------------------------+
+ |          Termine                   ||          Kalender          |
+ |------------------------------------||----------------------------|
+ |                      6. April 2006 ||         April 2006         |
+ |                                    ||Mon Die Mit Don Frei Sam Son|
+ |                                    ||                      1   2 |
+ |                                    ||  3   4   5   6   7   8   9 |
+ |                                    || 10  11  12  13  14  15  16 |
+ |                                    || 17  18  19  20  21  22  23 |
+ |                                    || 24  25  26  27  28  29  30 |
+ |                                    ||                            |
+ |                                    |+----------------------------+
+ |                                    |+----------------------------+
+ |                                    ||        Zu erledigen        | todo-
+ |                                    ||----------------------------| Panel
+ |                                    ||                            |   |
+ |                                    ||                            |   |
+ |                                    ||                            |<--.
+ |                                    ||                            |
+ |                                    ||                            |
+ |                                    ||                            |
+ +------------------------------------++----------------------------+
+ | ? Hilfe  R Neu zeichnen  H/L -/+1 Tag  G Gehe zu  C Einstellung  |
+ | Q Verlassen   S Speichern   J/K -/+1 Woche   Tab ändere Ansicht  |<-.
+ +------------------------------------------------------------------+  |
+                                                                       |
+                                                                 Statuszeile
+
+
+ +Das Kalender-Panel hebt den gewünschten Tag farblich hervor, während +das Termin-Panel die Liste mit Terminen des angesteuerten Tags +anzeigt. Das todo-Panel dagegen zeigt eine Liste mit den zu +erledigenden Aufgaben, die keinem bestimmten Tage zugeordnet sind. +Die letzten beiden Zeilen des Interfaces zeigen die Status-Zeile, die +über die möglichen Befehle und ihre entsprechenden Tasten informiert. + + +

calcurse Dateien

+

+ +Die folgende Verzeichnisstruktur wird im $HOME-Verzeichnis angelegt, +wenn calcurse das erste mal gestartet wird: +

+        $HOME/.calcurse/
+                  |___conf
+                  |___apts
+                  |___todo
+
+ + +Die conf Datei enthält die Informationen zur Benutzerkonfiguration.
+Die apts Datei enthält alle Termine.
+Die todo Datei enthält die todo-Liste. + + +

Online Hilfe

+

+Das integrierte Hilfe-System kann jederzeit mit '?' aufgerufen +werden. Informationen über bestimmte Befehle können mit der +entsprechenden Taste des Befehls aufgerufen werden. + + +

Optionen

+

+Alle calcurse Parameter sind im Konfigurationsmenü +einstellbar. Drücke Sie dazu die 'C'-Taste. Ein weiteres Untermenü +erscheint mit drei weiteren Auswahlpunkten: Ein erneutes Betätigen der +'C'-Taste führt zur Farbeinstellung, die 'L'-Taste erlaubt die Auswahl +eines anderen Layouts, das heisst die Anordnung der drei Panel kann +hier geändert werden. Mit der 'G'-Taste gelangt man zur Auswahl +allgemeiner Optionen. + + +

Allgemeine Optionen

+

+Diese Optionen steuert das allgemeine Verhalten von +calcurse wie im folgenden beschrieben wird: +

+ + +

Textfarben einstellen

+

+Die verwendeten Textfarben können nach eigenen Vorlieben eingestellt +werden. Durch Betätigung der entsprechenden Taste kann die gewünschte +Farbkombination ausgewählt werden. Die gewählte Farbkombination werden +dem Rahmen, dem Titel und der Status-Zeilen zugeordnet. + + Eine schwarz/weiss Kombination ist ebenfalls verfügbar, um Terminals ohne Farben zu unterstützen.
+ Beachte: +

+ + +

Layout einstellen

+

+Das Layout bezieht sich auf die Positionen der einzelnen Panel. Das +Standard-Layout zeigt das Kalender-Panel in der oberen linken Ecke des +Terminals, das todo-Panel befindet sich in der unteren rechten Ecke +und das Termin-Panel auf der linken Seite des Terminals (siehe die +Zeichnung im Abschnitt Interaktiver Modus, die das +Beispiel des Standard-Layouts zeigt).
+Durch Auswahl eines anderen Layouts kann der Benutzer das +Erscheinungsbild von calcurse nach seinen Wünschen +anpassen. + + +

Bekannte Fehler

+

+ + Es kommt vor, dass Wörter bei Verwendung der schwarz/weiss Farbkombination + falsch hervorgehoben werden, wenn die $TERM + Variable auf xterm-color gesetzt ist. + Um diesen Fehler zu umgehen, sollte nach Aussage von + Thomas E. Dickey (zuständig für das xterm), + xterm-xfree86 an Stelle für xterm-color als + $TERM Variable gesetzt werden:
+

+ "The xterm-color value for $TERM is a bad choice for XFree86 xterm + because it is commonly used for a terminfo entry which happens to + not support bce. Use the xterm-xfree86 entry which is distributed + with XFree86 xterm (or the similar one distributed with ncurses)." +
+ + + +

Mitteilung von Fehlern und Anregungen

+

+Bitte mailt Fehler oder auch Anregungen an: +

+        calcurse@culot.org
+
+oder an den Autor: +
+        frederic@culot.org
+
+ + +

Wie kann ich einen Beitrag leisten?

+

+Wenn Sie gerne dieses Projekt unterstützen möchten, können Sie mir +zuerst eine kurze Rückmeldung geben. Was finden Sie gut an diesem +Programm oder was könnte besser sein. Gibt es vielleicht Programmeigenschaften, +die Sie vermissen? Teilen Sie es mir mit!
+ + Von nun an ist es auch möglich sich an der Übersetzung der Prgrammmitteilungen + und der Dokumentation von calcurse zu beteiligen.
+
+ Beachte: Jegliche Unterstützung calcurse + in andere Sprachen zu übersetzen ist sehr willkommen. Doch bevor Sie beginnen, sollten + Sie eine Mail an calcurse-i18n@culot.org senden, um zu erfahren, ob jemand + die Übersetzung in Ihrer Sprache schon begonnen hat. + + + +

Übersetzung der Dokumentation

+

+ + Das doc/ Verzeichnis des Source-Packets enthält bereits + übesetzte Versionen der calcurse Anleitung. + Wenn eine Übersetzung in Ihrer Sprache noch nicht vorhanden ist, + wäre es grossartig, wenn Sie eine solche erstellen könnten.
+ Kopieren Sie dazu eine der vorhandenen Version mit dem Dateinamen + manual_XX.html, wobei XX + das entsprechende Kürzel Ihrer Sprache ist. Anschliessend übersetzen Sie diese + Datei und senden Sie dann an den Author (siehe Mitteilung von Fehlern und Anregungen), so dass Ihre Übersetzung für die nächste Ausgabe von calcurse ins Packet integriert werden kann. + +

calcurse i18n

+

+ Wie bereits erwähnt, verwendet calcurse die gettext Utilities um mehrsprachige Programmmitteilungen zu erzeugen. + Dieser Abschnitt informiert darüber, wie Programmmitteilungen in Ihrer Muttersprache + übersetzt werden. Dieses howto zur Übersetzung von calcurse mit gettext ist natürlich nur ein Einstieg und wohl zu kurz. Um umfassendere Informationen + zu erhalten und sich die weite Welt der Sprachübersetzung für Software zu erschliessen, + sollten Sie die Seite der GNU gettext Anleitung besuchen: + 

+                http://www.gnu.org/software/gettext/manual/
+
+ Eigentlich sind drei verschiedene Entwickler an der Übersetzung beteiligt: + Programmierer, Sprachkoordinator und Übersetzer. + Nach einem kurzen Überblick, wie so etwas funktioniert, werden anschliessend die + Aufgaben des Übersetzers beschrieben. + + +

Überblick

+

+Um Text in der Muttersprache des Benutzers erscheinen zu lassen, sind zwei Schritte nötig: + Internationalisierung + (i18n) und Lokalisierung (l10n). + Bei der i18n geht es darum ein Buch für mehrere Sprachen vorzubereiten. + Das wird vom Programmierer durchgeführt, der die zu übersetzenden Texte markiert + und es somit ermöglicht, dass zur Laufzeit des Programms der Text übersetzt erscheint. + Bei der l10n geht es darum, dem i18n markierten Pragramm calcurse die entsprechende Übersetzung des Benutzers zukommen zu lassen. Die zuvor vom Programmierer + markierten Texte werden durch das richtige Setzen der Umgebung für calcurse übersetzt.
+
+ + Also, die zu übersetzenden Texte werden zunächst vom Programmierer in der C Source-Datei markiert und in einer Template + Datei (calcurse.pot - die pot Dateierweiterung bedeutet + portable object template) gesammelt. + Der Inhalt dieser Template Datei wird dann mit den Dateien, die die Übersetzungen enthalten + (fr.po für französisch, hier steht po für portable object, + dieses Format kann man lesen und verändern), + zusammengeführt. Ein Übersetzer kann diese Datei dazu öffnen, die enthaltenen Texte übersetzen + und sie dann an den Programmierer zurück senden. + Wenn das Programm kompiliert wird, erzeugt der Kompiler (aus Gründen der Effizienz) + eine binäre Version dieser Datei (fr.mo - mo steht für machine + object, dieses Format kann nur von Programmen gelesen werden), die dann installiert wird. calcurse nutzt diese Datei zur Laufzeit, um die + Texte in Abhängigkeit zur lokalen Einstellung des Benutzers zu übersetzen. + + +

Aufgaben des Übersetzers

+

+ Wenn Sie mit der Übersetzung in eine neue Sprache beginnen möchte sind hier die Schritte dazu: +

+ + +

po-Dateien

+

+ Das Format der po-Dateien ist relativ einfach. po-Dateien bestehen aus fünf Teilen: +

    +
  1. location Zeilen: geben an, wo sich der Text befindet (Name der Datei und Zeilennummer). +
  2. msgid Zeilen: der zu übersetzende Text. +
  3. msgstr Zeilen: der übersetzte Text. +
  4. Zeilen, die mit '#' beginnen: Kommentare (einige mit spezieller Bedeutung, + wie wir weiter unten noch sehen werden). +
+ Übersetzen Sie die msgid Zeilen und tragen Sie den übersetzten Text in die mit + msgstr gekennzeichneten Zeilen ein. +

+ Einige Anmerkungen: +

+ + +

Links

+

+Dieser Abschnitt enthält Links und Angaben, die Sie interessieren +könnten. + + +

calcurse Internetseite

+

+Die Internetseite des Projekts calcurse lautet: +

+        http://culot.org/calcurse
+
+ + +

calcurse Ankündigungsliste

+

+Wenn Interesse an Calcurse besteht und Sie gerne über Neuerscheinungen +informiert werden möchten, können Sie gerne auf eine Liste gesetzt +werden, die Sie per Mail über die neusten Eigenschaften von +calcurse informiert, sobald ein neuer Release +erscheint.
+Um sich in die Liste eintragen zu lassen, senden Sie eine Mail an +calcurse-announce@culot.org mit "subscribe" im Betreff. + + +

Danksagungen

+

+Folgenden Leuten möchte ich gerne für Ihre Unterstützung danken, ohne +die dieses Projekt nicht möglich gewesen wäre. Hier ist die Liste +derjenigen, denen ich Danke sagen möchte: +

+Und zuletzt, vielen vielen Dank an alle calcurse +Benutzer, die mir Ihr Feedback mitgeteilt haben. + + +
+ +Copyright (c) 2004-2006 Frédéric Culot
+German translation by Michael Schulz <bloodshower.at.web.dot.de>
+Calcurse version 1.4 - Last change: May 07, 2006 + + + + + diff --git a/doc/manual_en.html b/doc/manual_en.html new file mode 100755 index 0000000..3b1420b --- /dev/null +++ b/doc/manual_en.html @@ -0,0 +1,783 @@ + + + + + +CALCURSE documentation + + + + +

CALCURSE - text-based organizer

+

+

+ +

Table of Contents

+ +

+ + +

Introduction

+

+ calcurse is a text-based personal organizer + which helps keeping track of events and everyday tasks. + It contains a calendar, a 'todo' list, and puts your + appointments in order. The user interface is configurable, + and one can choose between different color schemes and + layouts. All of the commands are documented within an + online help system. + + +

Overview

+

Creation history

+

+ I started thinking about this project when I was finishing + my Ph.D. in Astrophysics... It started to be a little hard + to organize myself, and I really needed a good tool to help + me in that difficult task ;)
+ I like programs which use Text User Interfaces, because they + are simple, fast, portable and efficient, so I thought about + working on coding a simple calendar using such an interface. + Moreover, I wanted to go on learning the C + language, which I only used for a while during my undergraduate + studies. So I thought that would be the good project to start + in order to get organized and to learn about a few + C things ! + Unfortunately, I finished my Ph.D. before finishing + calcurse, + but anyway, I still wanted to work on it, hoping it would + be helpful to other people. So here it is...
+
+ But why 'calcurse' anyway ? Well, it is simply the + concatenation of 'CALendar' and 'nCURSEs', the name of the + library used to build the user interface. + + +

Important features

+

+ Calcurse is multi-platform and intended to be + lightweight, fast and reliable. It is to be used inside a + console or terminal, locally or on a distant machine within + an ssh (or similar) connection.
+ Calcurse can be run in two different modes : + interactive or non-interactive mode. The first mode allows + oneself to view its own personal organizer almost everywhere, + thanks to the text-based interface. + The second mode permits to easily build reminders just by adding + calcurse with appropriate command line arguments + inside a cron tab or within a shell init script.
+ Moreover, calcurse was created with the end-user + in mind, and tends to be as friendly as possible. This means + a complete on-line help system, together with having all of + the possible actions displayed at any time inside a status bar. + The user interface is also configurable, and one can choose + between several color and layout combinations. + + +

Installation

+

Requirements

+

ncurses library

+

+ Calcurse requires only a C compiler, such as + cc or gcc, and the ncurses + library. + It would be very surprising not to have a valid ncurses + library already installed on your computer, but if not, you can + find it at the following url :
+ 

+		http://ftp.gnu.org/pub/gnu/ncurses/
+
+ +

gettext library

+

+ calcurse supports internationalization + (i18n hereafter) through the gettext + utilities. This means calcurse can produce + multi-lingual messages if compiled with native language + support (i.e. NLS). However, NLS is + optionnal and if you do not want to have support for + multi-lingual messages, you can disable this feature. This is + done by giving the --disable-nls option to + configure (see section Install process).
+ To check if the gettext utilities are + installed on your system, you can search for the + libintl.h header file for instance: + 

+                locate libintl.h
+
+ If this header file is not found, then you can obtain the + gettext sources at the following url :
+ 
+                 http://ftp.gnu.org/pub/gnu/gettext/
+
+ Note: Even if libintl.h is found on your + system, it can be wise to specify its location during the install process, by using the + --with-libintl-prefix option with + configure. Indeed, the configure + could fail to locate this library if installed in an uncommon + place. + + +

Install process

+

+ First you need to gunzip and untar the source archive: + 

+	tar zxvf calcurse-1.4.tar.gz
+
+ Once you meet the requirements and have extracted the archive, + the install process is quite simple, and follows the standard + three steps process: +
    +
  1. ./configure +
  2. make +
  3. make install (may require root privilege) +
+ Use ./configure --help to obtain a list of + possible options. + + +

calcurse basics

+

Invocation

+

Command line arguments

+

+ calcurse takes the following options from the + command line: + +

+
-a +
+ Print the appointments for the current day and exit.
+ Note: the calendar from which to read the appointments + can be specified using the '-c' flag.
+
+
-c +
+ Specify the calendar file to use.
+ The default calendar is ~/.calcurse/apts + (see section calcurse files).
+
+
-d +
+ Print the appointments for the given date or for the + given number of upcoming days, depending on the argument + format. Two possible formats are supported: +
    +
  • a date of the form 'mm/dd/yyyy'. +
  • a number 'n'. +
+ In the first case, the appointment list for the + specified date will be returned, while in the second + case the appointment list for the 'n' upcoming days + will be returned.
+ As an example, typing calcurse -d 3 + will display your appointments for today, tomorrow, + and the day after tomorrow.
+ Note: as for the '-a' flag, the calendar from + which to read the appointments can be specified using + the '-c' flag.
+
+
-h +
+ Print a short help text describing the supported + command-line options, and exit.
+
+
-t +
+ Print the 'todo' list and exit.
+
+
-v +
+ Display calcurse version and exit. +
+ +

Environment variable for i18n

+

+ calcurse can be compiled with native language + support (see gettext + library). Thus, if you wish to have messages displayed + into your native language, first make sure it is available by + looking at the po/LINGUAS file. + This file indicates the set of available languages by showing + the two-letters corresponding code (for exemple, fr + stands for french). If you do not find your language, it + would be greatly appreciated if you could help translating + calcurse (see the How to + contribute? section).
+ If your language is available, run + calcurse with the following command: + 

+                LC_ALL=fr_FR calcurse
+
+ where fr_FR is the locale name in this exemple, but + should be replaced by the locale corresponding to the desired + language. + +

User interface

+

Non-interactive mode

+

+ When called with at least one of the following arguments:
+ -a, -d, -t, + -h, -v
+ calcurse is started in non-interactive mode. + This means the desired information will be displayed, and + after that, calcurse simply quits and you are + driven back to the shell prompt.
+ That way, one can add a line such as 'calcurse -ta' + in its init config file to display at logon the list of tasks + and appointments scheduled for the current day. + + +

Interactive mode

+

+ When called without any argument or only with the + -c option, calcurse is started in + interactive mode. In this mode, you are shown an interface + containing three different panels which you can browse using + the 'TAB' key, plus a status bar (see figure below). + 

+
+ appointment panel---.                                   .---calendar panel
+                     |                                   |  
+                     v                                   v
+ +------------------------------------++----------------------------+
+ |          Appointments              ||          Calendar          |
+ |------------------------------------||----------------------------|
+ |                      April 6, 2006 ||         April 2006         |
+ |                                    ||Mon Tue Wed Thu Fri Sat Sun |
+ |                                    ||                      1   2 |
+ |                                    ||  3   4   5   6   7   8   9 |
+ |                                    || 10  11  12  13  14  15  16 |
+ |                                    || 17  18  19  20  21  22  23 |
+ |                                    || 24  25  26  27  28  29  30 |
+ |                                    ||                            |
+ |                                    |+----------------------------+
+ |                                    |+----------------------------+
+ |                                    ||            ToDo            | todo
+ |                                    ||----------------------------| panel
+ |                                    ||                            |   |
+ |                                    ||                            |   |
+ |                                    ||                            |<--.
+ |                                    ||                            |
+ |                                    ||                            |
+ |                                    ||                            |
+ +------------------------------------++----------------------------+
+ | ? Help     R Redraw    H/L -/+1 Day      G GoTo       C Config   | 
+ | Q Quit     S Save      J/K -/+1 Week   Tab Chg View              |<-. 
+ +------------------------------------------------------------------+  |
+                                                                       |
+                                                                 status bar
+
+
+ The first panel represents a calendar which allows to highligth + a particular day, the second one contains the list of the events + and appointments on that day, and the last one contains a list + of tasks to do but which are not assigned to any specific day. + In the bottom line of the screen there is a status bar, which + indicates the possible actions and the corresponding keystrokes. + + +

calcurse files

+

+ The following structure is created in your $HOME + directory the first time calcurse is run : + 

+        $HOME/.calcurse/
+                  |___conf
+                  |___apts
+                  |___todo
+
+ The conf file contains the user configuration.
+ The apts file contains all of the events and + user's appointments.
+ The todo file contains the todo list. + + +

Online help

+

+ At any time, the built-in help system can be invoked by + pressing the '?' key. Once viewing the help screens, + informations on a specific command can be accessed by pressing + the keystroke corresponding to that command. + +

Options

+

+ All of the calcurse parameters are configurable from the + Configuration menu available when pressing 'C'. You are then + driven to a submenu with three possible choices : pressing 'C' + again will lead you to the Color scheme configuration, + pressing 'L' allows you to choose the layout of the main + calcurse screen (in other words, where to put the three + different panels on screen), and last you can choose between + different general options by pressing 'G'. + +

General options

+

+ These options control calcurse general behavior, + as described below: +

    +
  • auto_save (default: yes)
    + This option allows to automatically save the user's data + (if set to yes) when quitting.
    + warning: No data will be automatically saved if + auto_save is set to no. This means + the user must press 'S' (for saving) in order to retrieve its + modifications.
    +
    +
  • confirm_quit (default: yes)
    + If set to yes, confirmation is required before + quitting, otherwise pressing 'Q' will cause calcurse + to quit without prompting for user confirmation.
    +
    +
  • confirm_delete (default: yes)
    + If this option is set to yes, pressing 'D' for + deleting an item (either a todo, appointment, + or event), will lead to a prompt asking for user + confirmation before removing the selected item from the list. + Otherwise, no confirmation will be needed before deleting the + item.
    +
    +
  • skip_system_dialogs (default: no)
    + Setting this option to yes will result in skipping the + system dialogs related to the saving and loading of data. + This can be useful to speed up the input/output processes.
    +
    +
  • skip_progress_bar (default: no)
    + If set to yes, this will cause the disappearing of the + progress bar which is usually shown when saving data to file. + If set to no, this bar will be displayed, together with + the name of the file being saved + (see section calcurse files).
    +
    +
  • week_begins_on_monday (default: yes)
    + One can choose between Monday and Sunday as the first day of the + week. If the option week_begins_on_monday is set to + yes, Monday will be first in the calendar view. Else if + the option is set to no, then Sunday will be the first + day of the week. +
+ + +

Color themes

+

+ calcurse color theme is configurable and is to be + chosen by typing the number corresponding to the desired + theme. This color will then be applied to the panel borders, + to the titles, to the keystrokes, and to general informations + displayed inside status bar. A black and white theme is also + available, in order to support non-color terminals.
+ Notes: +

    +
  • Depending on your terminal type and on the value of the + $TERM environnement variable, color could or + could not be supported. An error message will appear if you + try to change colors whereas your terminal does not support + this feature.
    +
    +
  • If you do know your terminal supports colors but could + not get calcurse to display them, try to set your + $TERM variable to another value (such as + xterm-xfree86 for instance). +
+ + +

Layout configuration

+

+ The layout corresponds to the position of the panels inside + calcurse screen. The default layout makes the + calendar panel to be displayed on the top-right corner of the + terminal, the todo panel on the bottom-right corner, while the + appointment panel is displayed on the left hand-side of the + screen (see the figure in section + Interactive mode + for an exemple of the default layout).
+ By choosing another layout in the configuration screen, user + can customize calcurse appearence to best suit + his needs by placing the different panels where needed. + + +

Known bugs

+

+ Incorrect highlighting of items appear when using calcurse + black and white theme together with a $TERM + variable set to xterm-color. + To fix this bug, and as advised by Thomas E. Dickey + (xterm maintainer), xterm-xfree86 + should be used instead of xterm-color to set + the $TERM variable:
+

+ "The xterm-color value for $TERM is a bad choice for XFree86 xterm + because it is commonly used for a terminfo entry which happens to + not support bce. Use the xterm-xfree86 entry which is distributed + with XFree86 xterm (or the similar one distributed with ncurses)." +
+ +

Reporting bugs and feedback

+

+ Please send bug reports and feedback to: + 

+        calcurse@culot.org
+
+ or to the author: + 
+        frederic@culot.org
+
+ +

How to contribute?

+

+ If you would like to contribute to the project, + you can first send your feedback on what you like or dislike, + and if there are features you miss in calcurse. + For now on, possible contributions concern the translation + of calcurse messages and documentation.
+
+ Note: Any help in getting calcurse + internationalized would be very welcomed, but before + contributing, send a mail to + calcurse-i18n@culot.org to know if someone + already started the translation process into your language. + +

Translating documentation

+

+ The doc/ directory of the source package already + contains translated version of calcurse + manual. However, if the manual is not yet available into your + native language, it would be appreciated if you could help + translating it.
+ To do so, just copy one of the existing manual + file to manual_XX.html, where XX + identifies your language. Then translate this newly created + file and send it to the author (see Reporting + bugs and feeback), so that it can be included in the + next calcurse release. + +

calcurse i18n

+

+ As already mentioned, gettext utilities are used + by calcurse to produce multi-lingual + messages. This section provides informations about how to + translate those messages into your native language. However, + this howto is deliberately incomplete, focusing on working + with gettext for calcurse + specifically. For more comprehensive informations or to grasp + the Big Picture of Native Language Support, you should refer + to the GNU gettext manual at: + 

+                http://www.gnu.org/software/gettext/manual/
+
+ Basically, three different people get involved in the + translation chain: coders, language coordinator, and + translators. After a quick overview of how things work, the + translator tasks will be described hereafter. + + +

Overview

+

+ To be able to display texts in the native language of the + user, two steps are required: internationalization + (i18n) and localization (l10n). i18n is about making + calcurse support multiple languages. It is + performed by coders, who will mark translatable texts and + provide a way to display them translated at runtime. l10n is + about making the i18n'ed calcurse adapt to the + specific language of the user, ie translating the strings + previously marked by the developers, and setting the + environment correctly for calcurse to use the + result of this translation.

+ + So, translatable strings are first marked by the coders within + the C source files, then gathered in a template + file (calcurse.pot - the pot extension + meaning portable object template). The content of + this template file is then merged with the translation files + for each language (fr.po for french, for instance - + with po standing for portable object, ie + meant to be read and edited by humans). A given translation + team will take this file, translate its strings, and send it + back to the developers. At compilation time, a binary version + of this file (for efficiency reasons) will be produced + (fr.mo - mo stands for machine + object, ie meant to be read by programs), and then + installed. Then calcurse will use this file at + runtime, translating the strings according to the locale + settings of the user. + + +

Translator tasks

+

+ Suppose someone wants to initiate the translation of a new + language. Here are the steps to follow: +

    +
  • First, find out what the locale name is. For instance, for + french, it is 'fr_FR', or simply 'fr'. This is the value the + user will have to put in his LC_ALL environment + variable for software to be translated (see Environment variable for + i18n).
    +
    +
  • Then, go into the po/ directory, and create a new po-file + from the template file using the following command: + 
    +                'msginit -i calcurse.pot -o fr.po -l fr --no-translator'
+
    + If you do not have msginit installed on your + system, simply copy the calcurse.pot file to + fr.po and edit the header by hand.
    + Now, having this fr.po file, the translator is ready + to begin. +
+ + +

po-files

+

+ The format of the po-files is quite simple. Indeed, po-files + are made of four things: +

    +
  1. location lines: tells you where the strings can + be seen (name of file and line number), in case you need to + see a bit of context. +
  2. msgid lines: the strings to translate. +
  3. msgstr lines: the translated strings. +
  4. lines prefixed with '#': comments (some with a + special meaning, as we will see below). +
+ Basically, all you have to do is fill the msgstr + lines with the translation of the above msgid + line. +

+ A few notes: +

    +
  • Fuzzy strings
    + You will meet strings marked with a "#, fuzzy" + comment. calcurse won't use the translations of + such strings until you do something about them. A string + being fuzzy means either that the string has already been + translated but has since been changed in the sources of the + program, or that this is a new string for which + gettext made a 'wild guess' for the translation, + based on other strings in the file. It means you have to + review the translation. Sometimes, the original string has + changed just because a typo has been fixed. In this case, you + won't have to change anything. But sometimes, the translation + will no longer be accurate and needs to be changed. Once you + are done and happy with the translation, just remove the + "#, fuzzy" line, and the translation will be used + again in calcurse.
    +
    +
  • c-format strings and special sequences
    + Some strings have the following comment: "#, + c-format". This tells that parts of the string to + translate have a special meaning for the program, and that you + should leave them alone. For instance, %-sequences, like + "%s". These means that calcurse will + replace them with another string. So it is important it + remains. There are also \-sequences, like \n or + \t. Leave them, too. The former represents an end + of line, the latter a tabulation.
    +
    +
  • Translations can be wrapped
    + If lines are too long, you can just break them like this: + 
    +                msgid ""
+                "some very long line"
+                "another line"
+
    +
  • po-file header
    + At the very beginning of the po-file, the first string form a + header, where various kind of information has to be filled + in. Most important one is the charset. It should resemble + 
    +                "Content-Type: text/plain; charset=utf-8\n"
+
    + You should also fill in the Last-Translator field, so that + potential contributors can contact you if they want to join + you in the translation team, or have remarks/typo fixes to + give about the translations. You can either just give your + name/nick, or add an email address, for exemple: + 
    +                "Last-Translator: Frederic Culot \n"
+
    +
  • Comments
    + Adding comments (lines begining with the '#' character) can be + a good way to point out problems or translation difficulties + to proofreaders or other members of your team.
    +
    +
  • Strings size
    + calcurse is a curses/console program, thus it can + be heavily dependant on the terminal size (number of + columns). You should think about this when translating. Often, + a string must fit into a single line (standard length is 80 + characters). Don't translate blindly, try to look where your + string will be displayed to adapt your translation.
    +
    +
  • A few useful tools
    + The po-file format is very simple, and the file can be edited + with a standard text editor. But if you prefer, there are few + specialized tools you may find convenient for translating: + +
    +
  • And finally
    + I hope you'll have fun contributing to a more + internationalized world. :) If you have any more questions, + don't hesitate to contact me at frederic@culot.org. +
+ + +

Links

+

+ This section contains links and references that may be of + interest to you. + + +

calcurse homepage

+

+ The calcurse homepage can be found at + 

+	http://culot.org/calcurse
+
+ +

calcurse announce list

+

+ If you are interested in the project and want to be warned + when a new release comes out, you can subscribe to the + calcurse announce list. In doing so, you will + receive an email as soon as a new feature appears in + calcurse.
+ To subscribe to this list, send a message to + calcurse-announce@culot.org with "subscribe" + in the subject field. + + +

Thanks

+

+ Its time now to thank other people without whom this program + would not exist! So here is a list of contributing persons I + would like to thank : +

    +
  • Alex for its patches, help and advices with C programming +
  • Gwen for testing and general discussions about how to + improve calcurse +
  • Kevin and Ryan for packaging calcurse for Debian +
  • Steffen for packaging calcurse for Archlinux +
  • Alexandre for packaging calcurse for Mac OsX +
  • Joel for its calendar script which inspired calcurse + calendar view +
  • Michael Schulz for the german translation of + calcurse manual +
  • people who write softwares I like and which inspired me, + especially : +
      +
    • vim for the displacement keys +
    • orpheus and abook for documentation +
    • pine and aptitude + for the text user interface +
    +
+
+ And last, many many thanks to all of the calcurse + users who sent me their feedback. + +
+ +Copyright (c) 2004-2006 Frédéric Culot
+Calcurse version 1.4 - Last change: May 07, 2006 + + + + + diff --git a/doc/manual_fr.html b/doc/manual_fr.html new file mode 100755 index 0000000..d7fbf6e --- /dev/null +++ b/doc/manual_fr.html @@ -0,0 +1,898 @@ + + + + + +documentation de CALCURSE + + + + +

CALCURSE - organiseur en mode texte

+

+

+ +

Table des matières

+ +

+ + +

Introduction

+

+ calcurse est un organiseur personnel en mode texte, + qui a pour but de gérer les rendez-vous et les tâches + à faire. Il est composé d'un calendrier, d'une + liste de tâches, et classe les rendez-vous. + L'interface utilisateur est configurable, et l'on peut + choisir entre différents thèmes graphiques (couleur et + disposition des élements de l'interface). + Toutes les commandes sont documentées dans un système + d'aide en ligne. + + +

Aperçu du logiciel

+

Origine de Calcurse

+

+ J'ai commencé à penser à ce projet à la fin de mon doctorat + en astrophysique... Je commençais en effet à avoir de plus + en plus de mal à m'organiser, et j'avais vraiment besoin d'un + bon outil pour m'aider dans cette tâche difficile ;)
+ D'autre part, j'apprécie beaucoup les logiciels qui font + appel à des Interfaces en Mode Texte, parce que je les trouve + plus simples, plus rapides, plus portables et plus efficaces. + J'ai alors commencé à programmer un calendrier rudimentaire + qui utilisait une interface de ce type. + En plus de cela, je voulais améliorer mes connaissances en + C, langage de programmation que je n'avais + utilisé jusqu'alors que dans le cadre de petits projets pendant + mes études. J'ai donc pensé que ce serait une bonne chose de me + lancer dans ce projet, puisque cela me permettrait à la fois de + mieux m'organiser, et d'apprendre à mieux programmer en + C! + Malheureusement, j'ai obtenu mon doctorat avant de terminer + calcurse, mais j'ai tout de même voulu continuer + à travailler + sur ce projet, en espérant que ce programme serait utile à + d'autres personnes. Voilà comment est né + calcurse...
+
+ Mais au fait, pourquoi 'calcurse' ? Et bien ce nom provient + simplement de la concaténation de 'CALendrier' et de 'nCURSEs', + qui est le nom de la librairie utilisée pour construire + l'interface utilisateur. + + +

Caractéristiques importantes

+

+ Calcurse est multi-plateformes et est conçu pour + être léger, rapide et fiable. Il doit être utilisé dans un + terminal ou une console, soit localement ou bien sur une + machine distante par l'intermediaire d'une liaison ssh (ou + similaire).
+ Calcurse peut être lancé dans deux modes différents: + soit interactif, soit non-interactif. Le premier mode permet + de visualiser son organiseur personnel pratiquement sous + n'importe quel environnement, grâce à l'interface en mode texte. + Le deuxième mode permet de créer facilement des penses-bête en + ajoutant calcurse avec les arguments appropriés dans + la table cron ou dans le script d'initialisation du shell.
+ De plus, calcurse a été créé en prenant en compte + l'utilisateur final à chaque étape de sa conception, c'est-à-dire + en essayant d'être le plus intuitif possible. Cela implique + la présence d'une aide en ligne exhaustive, ainsi que le rappel de + toutes les commandes possibles dans la barre de status. + L'interface utilisateur est également configurable, et l'on peut + choisir parmis de nombreuses combinaisons possibles de couleurs + et de positions des fenêtres. + + +

Installation

+

Pré-requis

+

Librairie ncurses

+

+ L'installation de Calcurse ne nécessite qu'un + compilateur C, comme cc ou gcc, + et la librairie ncurses. + Il serait très surprenant que vous n'ayez pas déjà la librairie + ncurses d'installée sur votre machine, mais si + c'est le cas, vous pourrez la trouver à l'adresse suivante :
+ 

+		http://ftp.gnu.org/pub/gnu/ncurses/
+
+ + +

Librairie gettext

+

+ calcurse s'aide de la librairie + gettext pour le support de l'internationalisation + (noté i18n ci-après). + Cela signifie que calcurse peut fournir des + messages multilingues si il est compilé avec le support + NLS (Native Language Support - Support de Langage + Natif). Cependant, ce support est optionnel et si vous + n'avez pas besoin de la traduction des messages + affichés, vous pouvez sésactiver cette option. + La désactivation du support NLS s'effectue en + passant l'option --disable-nls à + configure (voir la section Processus d'Installation).
+ Pour vérifier que les utilitaires gettext + sont bien installés sur votre systsème, vous + pouvez par exemple vérifier la présence du + fichier libintl.h en tapant : + 

+                locate libintl.h
+
+ Dans l'éventualité où ce fichier ne + serait pas trouvé, vous pouvez obtenir les sources de + gettext à l'adresse suivante :
+ 
+                 http://ftp.gnu.org/pub/gnu/gettext/
+
+ Remarque: Même si libintl.h est bien + localisé par la commande précédente, il + peut être utile de spécifier son emplacement au + moment de lancer le processus + d'installation, en passant l'option + --with-libintl-prefix au script + configure. En effet, ce script pourrait + ne pas trouver le fichier libintl.h si celui-ci + n'est pas installé dans un endroit usuel. + + +

Processus d'installation

+

+ Vous devez tout d'abord décompresser l'archive source de la + manière suivante : + 

+	tar zxvf calcurse-1.4.tar.gz
+
+ Une fois que vous remplissez tous les pré-requis nécessaires à + l'installation, le processus de compilation est simple et suit + les trois étapes usuelles : +
    +
  1. ./configure +
  2. make +
  3. make install (peut nécessiter les privilèges + super-utilisateur) +
+ Vous pouvez obtenir la liste des options possibles en tapant + ./configure --help. + + +

Présentation générale

+

Invocation

+

Arguments en ligne de commande

+

+ Lors de son appel en ligne de commande, calcurse + accepte les arguments suivants : + +

+
-a +
+ Affiche les rendez-vous pour la date du jour, puis quitte.
+ Remarque: le calendrier à utiliser peut être + spécifié en utilisant l'option '-c'.
+
+
-c +
+ Spécifie le fichier calendrier à uiliser.
+ Le calendrier par défaut est celui contenu dans + ~/.calcurse/apts + (voir la section Fichiers).
+
+
-d +
+ Affiche les rendez-vous pour la date ou pour le nombre de + jours indiqués, suivant le format de l'argument. Deux + formats différents sont acceptés : +
    +
  • une date sous la forme 'mm/jj/aaaa'. +
  • un nombre 'n'. +
+ Dans le premier cas, la liste des rendez-vous pour la + date spécifiée sera affichée, alors que dans le + deuxième cas, la liste des rendez-vous pour les 'n' + jours à venir sera retournée.
+ Par exemple, taper calcurse -d 3 fera + s'afficher les rendez-vous pour aujourd'hui, demain + et après-demain.
+ Remarque: comme pour l'option '-a', le fichier + contenant le calendrier à lire peut être spécifié en + utilisant l'option '-c'.
+
+
-h +
+ Affiche l'aide décrivant les options en ligne de commande, + puis quitte.
+
+
-t +
+ Affiche la liste des 'todo', puis quitte.
+
+
-v +
+ Affiche la version de calcurse, puis quitte. +
+ + +

Variable d'environnement +pour l'i18n

+

+ calcurse peut être compilé avec le + support NLS (voir Librairie + gettext). Ainsi, si vous voulez que les + messages affichés apparaissent dans votre langue + natale, assurez-vous tout d'abord que celle-ci est + présente dans le fichier po/LINGUAS. + Ce fichier indique toutes les traductions disponibles par + l'intermédiaire d'un code de deux lettres (par exemple, + fr représente le français). Si vous ne + trouvez pas votre langue, il serait très + apprécié que vous apportiez votre aide pour + traduire calcurse (voir la partie Comment contribuer?).
+ Si votre langue est disponible, lancez calcurse + en utilisant la commande suivante : + 

+                LC_ALL=fr_FR calcurse
+
+ où fr_FR doit être remplacé par + la locale (code de la langue suivi du code pays) + correspondant à la traduction voulue. + + +

Interface utilisateur

+

Mode non-interactif

+

+ Lorsque il est appelé avec au moins un des arguments suivants:
+ -a, -d, -t, + -h, -v
+ calcurse est lancé en mode non-interactif. + Cela signifie que l'information demandée sera affichée, + puis calcurse quittera et vous serez ramené + au prompt de l'interpréteur de commandes.
+ De ce manière, il est possible de rajouter une ligne telle + que 'calcurse -ta' dans le fichier d'initialisation + de son environnement, afin de faire s'afficher à chaque + début de session la liste des tâches à faire et des rendez-vous + planifiés pour la journée. + + +

Mode interactif

+

+ Lorsqu'il est appelé sans aucun argument ou uniquement avec + l'option '-c', calcurse est lancé + en mode interactif. Dans ce mode s'affiche une interface qui + contient trois panneaux différents, qu'il est possible de + sélectionner cycliquement en utilisant la touche 'TAB', ainsi + que d'une barre de status (voir la figure ci-dessous). + 

+
+ panneau rendez-vous---.                             .---panneau calendrier
+                       |                             |  
+                       v                             v
+ +------------------------------------++----------------------------+
+ |           Rendez-vous              ||         Calendrier         |
+ |------------------------------------||----------------------------|
+ |                      Avril 6, 2006 ||         Avril 2006         |
+ |                                    ||Lun Mar Mer Jeu Ven Sam Dim |
+ |                                    ||                      1   2 |
+ |                                    ||  3   4   5   6   7   8   9 |
+ |                                    || 10  11  12  13  14  15  16 |
+ |                                    || 17  18  19  20  21  22  23 |
+ |                                    || 24  25  26  27  28  29  30 |
+ |                                    ||                            |
+ |                                    |+----------------------------+
+ |                                    |+----------------------------+
+ |                                    ||           Tâches           | panneau
+ |                                    ||----------------------------| tâches à
+ |                                    ||                            |  faire
+ |                                    ||                            |   |
+ |                                    ||                            |<--.
+ |                                    ||                            |
+ |                                    ||                            |
+ |                                    ||                            |
+ +------------------------------------++----------------------------+
+ | ? Aide     R Retracer  H/L -+1 Jour      G Aller à    C Config   | 
+ | Q Quitter  S Sauver    J/K -+1 Sem.    Tab Chg vue               |<-. 
+ +------------------------------------------------------------------+  |
+                                                                       |
+                                                               barre de status
+
+
+ Le premier panneau représente un calendrier qui permet de + sélectionner un jour en particulier. Le second panneau contient + une liste d'évènements et les rendez-vous du jour, et le dernier + contient une liste des tâches à faire, mais qui ne sont pas + assignée à une journée en particulier. + En bas de l'écran on retrouve une barre de status, qui indique + les actions possibles en fonction du contexte, ainsi que la + touche qui doit être pressée pour effectuer cette action. + + +

Fichiers

+

+ La structure de fichiers suivante est créée dans le répertoire + $HOME de l'utilisateur la première fois que + calcurse est lancé : + 

+        $HOME/.calcurse/
+                  |___conf
+                  |___apts
+                  |___todo
+
+ Le fichier conf contient la configuration de l'utilisateur.
+ Le fichier apts contient tous les évenements ainsi que + les rendez-vous de l'utilisateur.
+ Le fichier todo contient la liste des tâches à effectuer. + + +

Aide en ligne

+

+ A n'importe quel moment, le système d'aide en ligne peut être + appelé en pressant la touche '?'. Une fois rentré dans l'aide, + les informations sur une commande spécifique peuvent être + obtenues en appuyant sur la touche correspondant à cette + commande. + + +

Options

+

+ Tous les paramètres de calcurse sont configurables + à partir du menu Configuration, accessible en appuyant + sur 'C'. L'utilisateur se voit alors présenté un second menu + avec trois choix possibles : appuyer à nouveau sur 'C' amène + au menu de sélection des couleurs de l'interface, appuyer sur + 'L' permet de choisir parmis différents emplacements pour les + panneaux de la fenêtre principale de calcurse, + et enfin les options générales peuvent être fixées en pressant + 'G'. + + +

Options générales

+

+ Ces options contrôlent le comportement général de + calcurse, comme décrit ci-dessous : +

    +
  • sauvegarde_automatique (valeur par défaut: oui)
    + Cette option permet de sauvegarder automatiquement les + données de l'utilisateur avant de quitter, si elle est + fixée à oui.
    + attention: Aucune donnée ne sera automatiquement + sauvegardée si cette variable est fixée à non. + Cela signifie que l'utilisateur doit appuyer sur 'S' + (pour sauvegarder) pour retrouver ses modifications au prochain + lancement de calcurse.
    +
    +
  • confirmer_pour_quitter (valeur par défaut: oui)
    + Si cette option est fixée à oui, la confirmation + de l'utilisateur est nécessaire avant de pouvoir quitter. + Autrement, appuyer sur 'Q' provoquera l'arrêt de + calcurse sans demander confirmation.
    +
    +
  • confirmer_pour_effacer (valeur par défaut: oui)
    + Si cette option est fixée à oui, appuyer sur 'D' + pour effacer un élement (soit une tâche, un rendez-vous ou bien + un évenement) provoquera l'apparition d'un message demandant + la confirmation de l'utilisateur avant d'effacer cet élement. + Si cette option est fixée à non, aucune confirmation + ne sera demandée avant l'effacement d'un élement.
    +
    +
  • masquer_messages_système (valeur par défaut: non)
    + Fixer cette option à oui provoque la disparition des + messages relatifs aux enregistrements ou lectures des fichiers + de données. Ceci peut être utile pour accélerer les processus + d'entrées/sorties.
    +
    +
  • masquer_barre_progression (valeur par défaut: non)
    + Si elle est fixée à oui, cette option provoque la + disparition de la barre de progression qui est normalement chargée + d'indiquer l'étât d'avancement de l'enregistrement des fichiers + de données. Si cette option est fixée à non, cette barre + sera affichée, en même temps que le nom du fichier de données + actuellement en cours d'écriture + (voir la section Fichiers).
    +
    +
  • semaine_commence_lundi (valeur par défaut: oui)
    + Il est possible dans calcurse d'indiquer quel est le premier + jour de la semaine, à savoir soit le lundi, soit le dimanche. + Si l'option semaine_commence_lundi est fixée à + oui, les semaines du calendrier commenceront le lundi. + Par contre si cette option est fixée à non, + les semaines débuteront le dimanche. +
+ + +

Thèmes graphiques

+

+ Le thème graphique de calcurse est + configurable et doit être choisi en appuyant sur le + numéro correspond à la couleur voulue. Cette + couleur est alors appliquée à la bordure des + panneaux, aux titres, aux combinaisons de touches, et aux + informations générales affichées dans la + barre de status. Un thème en noir et blanc est + également disponible, afin de supporter les terminaux + monochromes.
+ Remarques: +

    +
  • Suivant le type de terminal que vous utilisez, et suivant + la valeur de la variable d'environnement $TERM, + la couleur peut être supportée ou non. Un message + d'erreur apparaîtra si vous essayez d'appliquer un + thème graphique en couleur alors que votre terminal est + monochrome.
    +
    +
  • Si vous savez que votre terminal supporte les couleurs + mais que calcurse ne veut pas les afficher, + essayez de changer la valeur de la variable d'environnement + $TERM (appliquez par exemple la valeur + xterm-xfree86). +
+ + +

Disposition des panneaux

+

+ La disposition des panneaux à l'intérieur de la fenêtre de + calcurse peut être paramétrée. Par défaut, le + panneau contenant le calendrier se situe en haut à droite de + la fenêtre, le panneau contenant la liste des tâches est situé + en bas à droite, et le panneau contenant les rendez-vous se + trouve sur la partie gauche de l'écran (voir la figure dans la + section Mode interactif + pour un exemple de la disposition par défaut).
+ En choisissant une autre disposition pour les éléments composants + la fenêtre de calcurse, l'utilisateur peut adapter + à ses besoins l'interface du programme. + + +

Bogues connus

+

+ Une coloration incorrecte des objets peut résulter + d'une utilisation conjointe d'un thème graphique en + noir et blanc et d'une variable $TERM + fixée à xterm-color. Pour supprimer ce + bogue, et comme le conseille Thomas E. Dickey (le + résponsable du projet xterm), + xterm-xfree86 devrait être assigné + à la variable $TERM en lieu et place de + xterm-color : +

+ "La valeur xterm-color pour la variable $TERM est un mauvais + choix pour les terminaux XFree86 parce qu'elle est couramment + utilisée pour les entrées terminfo qui ne + supportent pas bce. Utilisez plutôt l'entrée + xterm-xfree86 qui est distribuée avec le xterm + d'XFree86 (ou par celui, similaire, distribué avec ncurses)." +
+ + +

Rapporter les bogues et commentaires

+

+ Merci de renvoyer vos rapports de bogues et vos commentaires à + l'adresse suivante : + 

+        calcurse@culot.org
+
+ ou directement à l'auteur : + 
+        frederic@culot.org
+
+ +

Comment contribuer?

+

+ Si vous désirez contribuer au projet, vous pouvez tout d'abord + envoyer vos commentaires sur ce qui vous plais ou déplais ou sur + ce qui vous manque dans calcurse.
+ Pour le moment, les contributions possibles concernent + la traduction des messages de calcurse ainsi que + de la documentation.
+
+ Remarque: toute contribution à la traduction de + calcurse serait très + appréciée, mais avant tout, envoyez un mail + à calcurse-i18n@culot.org pour savoir si + quelqu'un a déjà commencé le processus de + traduction dans votre langue. + + +

Traduction de la documentation

+

+ Le répertoire doc/ du paquet source contient + déjà des versions traduites de la documentation. + Cependant, si celle-ci n'est pas encore disponible dans votre + langue, votre aide pour sa traduction serait très + appréciée.
+ Pour cela, il suffit de copier un des fichiers existant et de + renommer cette copie en manual_XX.html, où + XX représente votre langue. Il faut ensuite + traduire ce fichier nouvellement créé et de + l'envoyer à l'auteur (voir Rapporter + les bogues et commentaires), pour qu'il soit inclus dans + la prochaine version de calcurse. + + +

Traduction de calcurse

+

+ Comme mentionné plus haut, les utilitaires + gettext sont utilisés par + calcurse pour produire des messages + multilingues. Cette section explique comment traduire ces + messages dans votre langue. Cependant, cette notice est + délibérément incomplète, + puisqu'elle ne se concentre que sur l'utilisation de + gettext avec calcurse. Pour avoir + une vision plus large du Support de Langage Natif + (NLS), il est préférable de se + référer au manuel de GNU gettext + que l'on peut trouver à l'adresse suivante : + 

+                http://www.gnu.org/software/gettext/manual/
+
+ Pour résumer, trois catégories de personnes sont + impliquées dans la chaîne de traduction : les + programmeurs, les coordinateurs de la traduction, et les + traducteurs. Après un rapide aperçu de la + manière de procéder pour traduire le logiciel, + nous décrirons plus en détails les tâches du + traducteur. + + +

Aperçu

+

+ Afin de pouvoir afficher du texte dans la langue natale de + l'utilisateur, deux étapes sont nécessaires : + l'internationalisation (i18n), et la + localisation (l10n). + l'i18n permet à calcurse d'être + multilingues. C'est un processus qui est mis en place par les + programmeurs, qui marquent les phrases à traduire au + sein du code source, et qui fournissent les outils pour que + ces phrases soient traduites automatiquement pendant le + déroulement du programme. + La l10n correspond quant à elle au processus qui permet + à calcurse de s'adapter à la langue + de l'utilisateur. C'est-à-dire qu'il traduit les + phrases précédemment marquée par les + programmeurs, et qu'il fixe correctement les variables + d'environnement afin que calcurse puisse utiliser + les résultats de cette traduction.
+
+ Ainsi, les phrases traduisibles sont tout d'abord + marquées par les programmeurs dans le code source, puis + rassemblées dans un fichier référence + (calcurse.pot - l'extension pot signifiant + portable object template, objet portable de + référence). Le contenu de ce fichier est alors + associé aux fichiers contenant la traduction pour + chacune des différentes langues (fichier fr.po + pour le français par exemple - po siginifiant + portable object, objet portable - qui peut être + lu par les humains). Le traducteur devra se servir de ce + fichier, et traduira les phrases qu'il contient, puis + l'enverra auw développeurs. Ensuite, au niveau de la + compilation du programme, une version binaire de ce fichier + sera produite (pour des raisons d'efficacité), puis + installée. Cette version binaire a pour extension + .mo, où mo signifie machine + object - objet machine, c'est-à-dire qui peut + être lu par le programme. Pour finir, + calcurse se servira de ce fichier mo + lors de son execution pour traduire les phrases dans la langue + de l'utilisateur. + + +

Etapes de la traduction

+

+ Supposons que quelqu'un veuille commencer une traduction dans + une nouvelle langue. Voici les étapes à suivre + pour ce faire : +

    +
  • Premièrement, trouver quel est le nom de la locale + correspondant à la langue à traduire. Par + exemple, pour le français, il s'agit de 'fr_FR', ou + simplement 'fr'. C'est cette valleur que l'utilisateur devra + mettre dans la variable d'environnement LC_ALL + pour obtenir la version traduite du logiciel (voir Variable d'environnement + pour l'i18n).
    +
    +
  • Ensuite, il faut se rendre dans le répertoire + po/, et créer un nouveau fichier .po + à partir du fichier de référence en + utilisant la commande suivante : + 
    +                'msginit -i calcurse.pot -o fr.po -l fr --no-translator'
+
    + Si vous n'avez pas msginit installé sur + votre système, vous pouvez plus simplement copier + calcurse.pot en fr.po par exemple, et editer + l'en-tête du fichier nouvellement créé + manuellement.
    + Maintenant, ayant à disposition ce fichier + fr.po, la traduction peut commencer. +
+ + +

Fichiers po

+

+ Le format des fichiers po est assez simple. En effet, + ils ne contiennent que quatre éléments + différents : +

    +
  1. ligne d'emplacement: renseigne sur l'emplacement + de la phrase dans le fichier source (donne le nom du fichier + ainsi que le numéro de ligne), afin de retrouver + simplement le contexte d'où est issu la phrase à + traduire. +
  2. ligne msgid: indique la phrase à traduire. +
  3. ligne msgstr: ligne indiquant la phrase traduite. +
  4. lignes commençant par '#': indiquent des + commentaires (certains ont une signification spéciale, + comme nous le verrons plus tard). +
+ Pour résumer, un traducteur doit simplement remplir les + champs msgstr avec la traduction des lignes + trouvées juste au dessus dans la partie msgid. +

+ Remarques: +

    +
  • Phrases marquées Fuzzy
    + Vous pourrez rencontrer des phrases commençant par le + commentaire "#, fuzzy". + calcurse n'utilisera pas les traductions + commençant par ce commentaire, à moins que vous + ne transformiez ces phrases. En effet, le commentaire + fuzzy signifie que la phrase a déjà + été traduite mais qu'elle a depuis + été changée dans le source du programme, + ou bien que gettext a effectué lui-même + uen traduction, en se basant sur une phrase similaire. Cela + implique donc que vous devez vérifier la traduction. + Parfois, la phrase originale a changé suite à + une correction de faute de frappe. Dans ce cas, vous n'aurez + pas besoin de modifier la traduction. Mais dans d'autres cas, + cette traduction peut ne plus être valable et + nécessitera alors une mise à jour. Une fois + cette mise à jour effectuée, vous pouvez + supprimer + le commentaire "#, fuzzy", et la traduction sera + alors à nouveau prise en compte par calcurse.
    +
    +
  • Lignes au format C et séquences spéciales
    + Certaines phrases ont le commentaire suivant: "#, + c-format". Cela signifie que des parties du texte + à traduire ont une signification particulière + pour le programme, et qu'il ne faut pas les modifier. Par + exemple, les séquences contenant des %, comme + "%s". Cela signifie que calcurse + remplacera ces séquences par d'autres expressions. Il + est donc important de ne pas les modifier. Il existe + également des séquences contenant des + /, comme \n ou \t. Il ne + faut pas les modifier non plus. En effet, la première + séquence représente une fin de ligne, et la + deuxième une tabulation.
    +
    +
  • Découpage des traductions
    + Si certaines lignes sont trop longues, il est possible de + découper les phrases comme dans l'exemple ci-après: + 
    +                msgid ""
+                "une ligne très longue"
+                "une autre ligne"
+
    +
  • En-tête des fichiers po
    + Au tout début du fichier po, la + première phrase forme un en-tête où + différentes informations doivent être + renseignées. La plus importante est le jeu de + caractès utilisé. Cette information devrait + ressembler à + 
    +                "Content-Type: text/plain; charset=utf-8\n"
+
    + Il est également nécessaire de remplir le champ + Last-Translator - Dernier Traducteur, afin + que d'autres traducteurs potentiels puissent se mettre en + relation avec la dernière personne ayant + retouché le fichier. De cette manière, il est + plus simple de coordonner les efforts de traduction. Il est + possible de rajouter son adresse de courrier + électronique, par exemple: + 
    +                "Last-Translator: Frederic Culot \n"
+
    +
  • Commentaires
    + Ajouter des commentaires (lignes commençant par '#') + peut être un bon moyen de signaler des problèmes ou + difficultés de traduction aux autres traducteurs.
    +
    +
  • Taille des phrases
    + calcurse est un programme comportant une + interface console/curses, il dépend donc de la taille + du terminal utilisé (plus particulièrement du + nombre de colonnes). Il est important de garder ceci en + mémoire au moment de la traduction. Souvent, la phrase + à traduire doit tenir dans une seule ligne (soit en + général 80 caractères). Il faut en tenir + compte, et essayer de voir où la phrase sera + placée pour adapter sa traduction.
    +
    +
  • Quelques outils utiles
    + Le format des fichiers po est relativement simple, et + ils peuvent être modifiés avec un éditeur + de texte standard. Mais il est également possible + d'utiliser des outils spécialisés pour cette + tâche: + +
    +
  • Finallement...
    + J'éspère que vous prendrez plaisir à + contribuer à l'internationalisation du monde des + logiciels libres. :) Si vous avez d'autres questions + concernant ce processus, n'hésitez pas à me + contacter à l'adresse frederic@culot.org. +
+ + +

Liens

+

+ Cette section contient des liens en relation avec + calcurse qui peuvent vous être utiles. + + +

Site internet de calcurse

+

+ La page web de calcurse est à l'adresse suivante : + 

+	http://culot.org/calcurse
+
+ +

Liste de diffusion de calcurse

+

+ Si vous êtes interessé par ce projet et que vous souhaitez + être prévenu lorsqu'une nouvelle version est diffusée, vous + pouvez souscrire à la liste de diffusion de calcurse. + De cette manière, vous recevrez un mél dès qu'une nouvelle + version est disponible.
+ Pour souscrire à cette liste, envoyez un message à l'adresse + calcurse-announce@culot.org avec "subscribe" dans + le sujet du mél. + + +

Remerciements

+

+ Je voudrais remercier ici toutes les personnes sans qui ce projet + n'aurait jamais pu voir le jour! En particulier : +

    +
  • Alex pour ses patches, aides et conseils sur la programmation en + C +
  • Gwen pour les tests et les discussions sur la manière d'améliorer + calcurse +
  • Kevin et Ryan pour la maintenance du paquet calcurse + pour Debian +
  • Steffen pour la maintenance du paquet calcurse pour + Archlinux +
  • Alexandre pour la maintenance du paquet calcurse pour + Mac OsX +
  • Joel pour son script de calendrier qui a inspiré celui de + calcurse +
  • Michael Schulz pour la traduction allemande du manuel de calcurse +
  • les personnes qui écrivent des logiciels que j'apprécie et qui + m'ont inspiré lors de la conception de ce projet, en particulier : +
      +
    • vim pour les touches de déplacement +
    • orpheus et abook pour la documentation +
    • pine et aptitude + pour l'interface en mode texte +
    +
+ Et pour terminer, un très grand merci à tous les utilisateurs de + calcurse qui m'ont fait parvenir leur commentaires. + +
+ +Copyright (c) 2004-2006 Frédéric Culot
+Calcurse version 1.4 - Dernière modification: 7 Mai 2006 + + + + + -- cgit v1.2.3-70-g09d2