summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/add.txt63
-rw-r--r--doc/config.txt22
-rw-r--r--doc/copy_paste.txt13
-rw-r--r--doc/delete.txt18
-rw-r--r--doc/displacement.txt6
-rw-r--r--doc/edit.txt31
-rw-r--r--doc/enote.txt37
-rw-r--r--doc/export.txt15
-rw-r--r--doc/flag.txt23
-rw-r--r--doc/general.txt13
-rw-r--r--doc/goto.txt13
-rw-r--r--doc/import.txt27
-rw-r--r--doc/other.txt12
-rw-r--r--doc/pipe.txt4
-rw-r--r--doc/priority.txt21
-rw-r--r--doc/repeat.txt23
-rw-r--r--doc/save.txt5
-rw-r--r--doc/tab.txt14
-rw-r--r--doc/view.txt13
-rw-r--r--doc/vnote.txt30
20 files changed, 212 insertions, 191 deletions
diff --git a/doc/add.txt b/doc/add.txt
index fa038d2..ca77787 100644
--- a/doc/add.txt
+++ b/doc/add.txt
@@ -1,37 +1,38 @@
Add
===
-Add an item in either the TODO or Appointment list, depending on which
-panel is selected when you press 'a'.
+Add an item in either the TODO or Appointment list, depending on which panel is
+selected when you press 'a'.
To enter a new item in the TODO list, you will need first to enter the
description of this new item. Then you will be asked to specify the todo
-priority. This priority is represented by a number going from 9 for the
-lowest priority, to 1 for the highest one. It is still possible to
-change the item priority afterwards, by using the '+' and '-' keys
-inside the todo panel.
-
-If the APPOINTMENT panel is selected while pressing 'a', you will be
-able to enter either a new appointment or a new all-day long event.
-To enter a new event, press [ENTER] instead of the item start time, and
-just fill in the event description.
-To enter a new appointment to be added in the APPOINTMENT list, you
-will need to enter successively the time at which the appointment
-begins, the appointment length (either by specifying the end time in
-[hh:mm] or the duration in [+hh:mm], [+xxdxxhxxm] or [+mm] format),
-and the description of the event.
-
-The day at which occurs the event or appointment is the day currently
-selected in the calendar, so you need to move to the desired day before
-pressing 'a'.
-
-Notes:
- o if an appointment lasts for such a long time that it continues
- on the next days, this event will be indicated on all the
- corresponding days, and the beginning or ending hour will be
- replaced by '..' if the event does not begin or end on the day.
- o if you only press [ENTER] at the APPOINTMENT or TODO event
- description prompt, without any description, no item will be
- added.
- o do not forget to save the calendar data to retrieve the new
- event next time you launch Calcurse.
+priority. This priority is represented by a number going from 9 for the lowest
+priority, to 1 for the highest one. It is still possible to change the item
+priority afterwards, by using the '+' and '-' keys inside the todo panel.
+
+If the APPOINTMENT panel is selected while pressing 'a', you will be able to
+enter either a new appointment or a new all-day long event. To enter a new
+event, press [ENTER] instead of the item start time, and just fill in the event
+description.
+
+To enter a new appointment to be added in the APPOINTMENT list, you will need
+to enter successively the time at which the appointment begins, the appointment
+length (either by specifying the end time in [hh:mm] or the duration in
+[+hh:mm], [+xxdxxhxxm] or [+mm] format), and the description of the event.
+
+The day at which occurs the event or appointment is the day currently selected
+in the calendar, so you need to move to the desired day before pressing 'a'.
+
+Notes
+-----
+
+* If an appointment lasts for such a long time that it continues on the next
+ days, this event will be indicated on all the corresponding days, and the
+ beginning or ending hour will be replaced by '..' if the event does not begin
+ or end on the day.
+
+* If you only press [ENTER] at the APPOINTMENT or TODO event description
+ prompt, without any description, no item will be added.
+
+* Do not forget to save the calendar data to retrieve the new event next time
+ you launch Calcurse.
diff --git a/doc/config.txt b/doc/config.txt
index f69d158..494dfe4 100644
--- a/doc/config.txt
+++ b/doc/config.txt
@@ -1,17 +1,21 @@
Config
======
-Open the configuration submenu.
-From this submenu, you can select between color, layout, notification
-and general options, and you can also configure your keybindings.
+Open the configuration submenu. From this submenu, you can select between
+color, layout, notification and general options, and you can also configure
+your keybindings.
The color submenu lets you choose the color theme.
-The layout submenu lets you choose the Calcurse screen layout, in other
-words where to place the three different panels on the screen.
-The general options submenu brings a screen with the different options
-which modifies the way Calcurse interacts with the user.
+
+The layout submenu lets you choose the Calcurse screen layout, in other words
+where to place the three different panels on the screen.
+
+The general options submenu brings a screen with the different options which
+modifies the way Calcurse interacts with the user.
+
The notify submenu allows you to change the notify-bar settings.
+
The keys submenu lets you define your own key bindings.
-Do not forget to save the calendar data to retrieve your configuration
-next time you launch Calcurse. \ No newline at end of file
+Do not forget to save the calendar data to retrieve your configuration next
+time you launch Calcurse.
diff --git a/doc/copy_paste.txt b/doc/copy_paste.txt
index 0cff341..261873a 100644
--- a/doc/copy_paste.txt
+++ b/doc/copy_paste.txt
@@ -1,11 +1,10 @@
Copy and Paste
==============
-Copy and paste the currently selected item. This is useful to quickly
-copy an item from one date to another. To do so, one must first
-highlight the item that needs to be copied, then press 'c' to copy.
-Once the new date is chosen in the calendar, the appointment panel must
-be selected and the 'p' key must be pressed to paste the item. The item
-will appear in the appointment panel, assigned to the newly selected
-date.
+Copy and paste the currently selected item. This is useful to quickly copy an
+item from one date to another. To do so, one must first highlight the item that
+needs to be copied, then press 'c' to copy. Once the new date is chosen in the
+calendar, the appointment panel must be selected and the 'p' key must be
+pressed to paste the item. The item will appear in the appointment panel,
+assigned to the newly selected date.
diff --git a/doc/delete.txt b/doc/delete.txt
index 937b9a6..ce1a496 100644
--- a/doc/delete.txt
+++ b/doc/delete.txt
@@ -3,15 +3,13 @@ Delete
Delete an element in the TODO or Appointment list.
-Depending on which panel is selected when you press the delete key,
-the hilighted item of either the TODO or Appointment list will be
-removed from this list.
+Depending on which panel is selected when you press the delete key, the
+hilighted item of either the TODO or Appointment list will be removed from this
+list.
-If the item to be deleted is recurrent, you will be asked if you
-wish to suppress all of the item occurences or just the one you
-selected.
+If the item to be deleted is recurrent, you will be asked if you wish to
+suppress all of the item occurences or just the one you selected.
-If the general option 'confirm_delete' is set to 'YES', then you will
-be asked for confirmation before deleting the selected event.
-Do not forget to save the calendar data to retrieve the modifications
-next time you launch Calcurse. \ No newline at end of file
+If the general option 'confirm_delete' is set to 'YES', then you will be asked
+for confirmation before deleting the selected event. Do not forget to save the
+calendar data to retrieve the modifications next time you launch Calcurse.
diff --git a/doc/displacement.txt b/doc/displacement.txt
index 18a3a34..cfd2a97 100644
--- a/doc/displacement.txt
+++ b/doc/displacement.txt
@@ -2,6 +2,7 @@ Displacement keys
=================
Move around inside calcurse screens.
+
The following scheme summarizes how to get around:
move up
@@ -20,6 +21,5 @@ The following scheme summarizes how to get around:
move to next week
move down
-Moreover, while inside the calendar panel, the '0' key moves
-to the first day of the week, and the '$' key selects the last day of
-the week.
+Moreover, while inside the calendar panel, the '0' key moves to the first day
+of the week, and the '$' key selects the last day of the week.
diff --git a/doc/edit.txt b/doc/edit.txt
index 56554fa..27b8528 100644
--- a/doc/edit.txt
+++ b/doc/edit.txt
@@ -2,17 +2,22 @@ Edit Item
=========
Edit the item which is currently selected.
-Depending on the item type (appointment, event, or todo), and if it is
-repeated or not, you will be asked to choose one of the item properties
-to modify. An item property is one of the following: the start time, the
-end time, the description, or the item repetition.
-Once you have chosen the property you want to modify, you will be shown
-its actual value, and you will be able to change it as you like.
-Notes:
- o if you choose to edit the item repetition properties, you will
- be asked to re-enter all of the repetition characteristics
- (repetition type, frequence, and ending date). Moreover, the
- previous data concerning the deleted occurences will be lost.
- o do not forget to save the calendar data to retrieve the
- modified properties next time you launch Calcurse. \ No newline at end of file
+Depending on the item type (appointment, event, or todo), and if it is repeated
+or not, you will be asked to choose one of the item properties to modify. An
+item property is one of the following: the start time, the end time, the
+description, or the item repetition.
+
+Once you have chosen the property you want to modify, you will be shown its
+actual value, and you will be able to change it as you like.
+
+Notes
+-----
+
+* If you choose to edit the item repetition properties, you will be asked to
+ re-enter all of the repetition characteristics (repetition type, frequence,
+ and ending date). Moreover, the previous data concerning the deleted
+ occurences will be lost.
+
+* Do not forget to save the calendar data to retrieve the modified properties
+ next time you launch Calcurse.
diff --git a/doc/enote.txt b/doc/enote.txt
index e928960..a4dea0e 100644
--- a/doc/enote.txt
+++ b/doc/enote.txt
@@ -1,21 +1,24 @@
EditNote
========
-Attach a note to any type of item, or edit an already existing note.
-This feature is useful if you do not have enough space to store all
-of your item description, or if you would like to add sub-tasks to an
-already existing todo item for example.
-Before pressing the 'n' key, you first need to highlight the item you
-want the note to be attached to. Then you will be driven to an
-external editor to edit your note. This editor is chosen the following
-way:
- o if the 'VISUAL' environment variable is set, then this will be
- the default editor to be called.
- o if 'VISUAL' is not set, then the 'EDITOR' environment variable
- will be used as the default editor.
- o if none of the above environment variables is set, then
- '/usr/bin/vi' will be used.
+Attach a note to any type of item, or edit an already existing note. This
+feature is useful if you do not have enough space to store all of your item
+description, or if you would like to add sub-tasks to an already existing todo
+item for example.
-Once the item note is edited and saved, quit your favorite editor.
-You will then go back to Calcurse, and the '>' sign will appear in front
-of the highlighted item, meaning there is a note attached to it. \ No newline at end of file
+Before pressing the 'n' key, you first need to highlight the item you want the
+note to be attached to. Then you will be driven to an external editor to edit
+your note. This editor is chosen the following way:
+
+* If the 'VISUAL' environment variable is set, then this will be the default
+ editor to be called.
+
+* If 'VISUAL' is not set, then the 'EDITOR' environment variable will be used
+ as the default editor.
+
+* If none of the above environment variables is set, then '/usr/bin/vi' will be
+ used.
+
+Once the item note is edited and saved, quit your favorite editor. You will
+then go back to Calcurse, and the '>' sign will appear in front of the
+highlighted item, meaning there is a note attached to it.
diff --git a/doc/export.txt b/doc/export.txt
index 570257d..0f6a8c9 100644
--- a/doc/export.txt
+++ b/doc/export.txt
@@ -2,13 +2,13 @@ Export
======
Export calcurse data (appointments, events and todos).
-This leads to the export submenu, from which you can choose between
-two different export formats: 'ical' and 'pcal'. Choosing one of
-those formats lets you export calcurse data to icalendar or pcal
-format.
-You first need to specify the file to which the data will be exported.
-By default, this file is:
+This leads to the export submenu, from which you can choose between two
+different export formats: 'ical' and 'pcal'. Choosing one of those formats lets
+you export calcurse data to icalendar or pcal format.
+
+You first need to specify the file to which the data will be exported. By
+default, this file is:
~/calcurse.ics
@@ -18,5 +18,4 @@ for an ical export, and:
for a pcal export.
-Calcurse data are exported in the following order:
- events, appointments, todos.
+Calcurse data are exported in the following order: events, appointments, todos.
diff --git a/doc/flag.txt b/doc/flag.txt
index 7941167..fb04d88 100644
--- a/doc/flag.txt
+++ b/doc/flag.txt
@@ -1,15 +1,16 @@
Flag Item
=========
-Toggle an appointment's 'important' flag or a todo's 'completed' flag.
-If a todo is flagged as completed, its priority number will be replaced
-by an 'X' sign. Completed tasks will no longer appear in exported data
-or when using the '-t' command line flag (unless specifying '0' as the
-priority number, in which case only completed tasks will be shown).
+Toggle an appointment's 'important' flag or a todo's 'completed' flag. If a
+todo is flagged as completed, its priority number will be replaced by an 'X'
+sign. Completed tasks will no longer appear in exported data or when using the
+'-t' command line flag (unless specifying '0' as the priority number, in which
+case only completed tasks will be shown).
-If an appointment is flagged as important, an exclamation mark appears
-in front of it, and you will be warned if time gets closed to the
-appointment start time.
-To customize the way one gets notified, the configuration submenu lets
-you choose the command launched to warn user of an upcoming appointment,
-and how long before it he gets notified. \ No newline at end of file
+If an appointment is flagged as important, an exclamation mark appears in front
+of it, and you will be warned if time gets closed to the appointment start
+time.
+
+To customize the way one gets notified, the configuration submenu lets you
+choose the command launched to warn user of an upcoming appointment, and how
+long before it he gets notified.
diff --git a/doc/general.txt b/doc/general.txt
index 53c71e8..ebfaca0 100644
--- a/doc/general.txt
+++ b/doc/general.txt
@@ -1,8 +1,9 @@
Generic keybindings
===================
-Some of the keybindings apply whatever panel is selected. They are
-called generic keybinding.
+Some of the keybindings apply whatever panel is selected. They are called
+generic keybinding.
+
Here is the list of all the generic key bindings, together with their
corresponding action:
@@ -21,7 +22,7 @@ corresponding action:
'y' : +1 Year -> move to next year
'^G' : Goto today -> move to current day
-The '^P' and '^N' keys are used to scroll text upward or downward
-when inside specific screens such the help screens for example.
-They are also used when the calendar screen is selected to switch
-between the available views (monthly and weekly calendar views). \ No newline at end of file
+The '^P' and '^N' keys are used to scroll text upward or downward when inside
+specific screens such the help screens for example. They are also used when
+the calendar screen is selected to switch between the available views (monthly
+and weekly calendar views).
diff --git a/doc/goto.txt b/doc/goto.txt
index c6b6482..8f1cae2 100644
--- a/doc/goto.txt
+++ b/doc/goto.txt
@@ -3,10 +3,11 @@ Goto
Jump to a specific day in the calendar.
-Using this command, you do not need to travel to that day using
-the displacement keys inside the calendar panel.
-If you hit [ENTER] without specifying any date, Calcurse checks the
-system current date and you will be taken to that date.
+Using this command, you do not need to travel to that day using the
+displacement keys inside the calendar panel.
-Notice that pressing '^G', whatever panel is
-selected, will select current day in the calendar. \ No newline at end of file
+If you hit [ENTER] without specifying any date, Calcurse checks the system
+current date and you will be taken to that date.
+
+Notice that pressing '^G', whatever panel is selected, will select current day
+in the calendar.
diff --git a/doc/import.txt b/doc/import.txt
index 65d963e..9f64348 100644
--- a/doc/import.txt
+++ b/doc/import.txt
@@ -2,18 +2,19 @@ Import
======
Import data from an icalendar file.
-You will be asked to enter the file name from which to load ical
-items. At the end of the import process, and if the general option
-'system_dialogs' is set to 'yes', a report indicating how many items
-were imported is shown.
+
+You will be asked to enter the file name from which to load ical items. At the
+end of the import process, and if the general option 'system_dialogs' is set to
+'yes', a report indicating how many items were imported is shown.
+
This report contains the total number of lines read, the number of
-appointments, events and todo items which were successfully imported,
-together with the number of items for which problems occured and that
-were skipped, if any.
+appointments, events and todo items which were successfully imported, together
+with the number of items for which problems occured and that were skipped, if
+any.
+
+If one or more items could not be imported, one has the possibility to read the
+import process report in order to identify which problems occured.
-If one or more items could not be imported, one has the possibility to
-read the import process report in order to identify which problems
-occured.
-In this report is shown one item per line, with the line in the input
-stream at which this item begins, together with the description of why
-the item could not be imported.
+In this report is shown one item per line, with the line in the input stream at
+which this item begins, together with the description of why the item could not
+be imported.
diff --git a/doc/other.txt b/doc/other.txt
index 4e17df7..663554d 100644
--- a/doc/other.txt
+++ b/doc/other.txt
@@ -2,8 +2,10 @@ OtherCmd
========
Switch between status bar help pages.
-Because the terminal screen is too narrow to display all of the
-available commands, you need to press 'o' to see the next set of
-commands together with their keybindings.
-Once the last status bar page is reached, pressing 'o' another time
-leads you back to the first page. \ No newline at end of file
+
+Because the terminal screen is too narrow to display all of the available
+commands, you need to press 'o' to see the next set of commands together with
+their keybindings.
+
+Once the last status bar page is reached, pressing 'o' another time leads you
+back to the first page.
diff --git a/doc/pipe.txt b/doc/pipe.txt
index 507147e..2d0c6a7 100644
--- a/doc/pipe.txt
+++ b/doc/pipe.txt
@@ -3,7 +3,7 @@ Pipe
Pipe the selected item to an external program.
-Press the '|' key to pipe the currently selected appointment or
-todo entry to an external program.
+Press the '|' key to pipe the currently selected appointment or todo entry to
+an external program.
You will be driven back to calcurse as soon as the program exits.
diff --git a/doc/priority.txt b/doc/priority.txt
index 678d7dc..61573c3 100644
--- a/doc/priority.txt
+++ b/doc/priority.txt
@@ -2,16 +2,15 @@ Priority
========
Change the priority of the currently selected item in the TODO list.
-Priorities are represented by the number appearing in front of the
-todo description. This number goes from 9 for the lowest priority to
-1 for the highest priority.
-Todo having higher priorities are placed first (at the top) inside the
-todo panel.
+Priorities are represented by the number appearing in front of the todo
+description. This number goes from 9 for the lowest priority to 1 for the
+highest priority. Todo having higher priorities are placed first (at the top)
+inside the todo panel.
-If you want to raise the priority of a todo item, you need to press '+'.
-In doing so, the number in front of this item will decrease, meaning its
-priority increases. The item position inside the todo panel may change,
-depending on the priority of the items above it.
+If you want to raise the priority of a todo item, you need to press '+'. In
+doing so, the number in front of this item will decrease, meaning its priority
+increases. The item position inside the todo panel may change, depending on the
+priority of the items above it.
-At the opposite, to lower a todo priority, press '-'. The todo position
-may also change depending on the priority of the items below. \ No newline at end of file
+At the opposite, to lower a todo priority, press '-'. The todo position may
+also change depending on the priority of the items below.
diff --git a/doc/repeat.txt b/doc/repeat.txt
index f79f2e9..79a4b49 100644
--- a/doc/repeat.txt
+++ b/doc/repeat.txt
@@ -2,10 +2,10 @@ Repeat
======
Repeat an event or an appointment.
-You must first select the item to be repeated by moving inside the
-appointment panel. Then pressing 'r' will lead you to a set of three
-questions, with which you will be able to specify the repetition
-characteristics:
+
+You must first select the item to be repeated by moving inside the appointment
+panel. Then pressing 'r' will lead you to a set of three questions, with which
+you will be able to specify the repetition characteristics:
o type: you can choose between a daily, weekly, monthly or
yearly repetition by pressing 'D', 'W', 'M' or 'Y'
@@ -23,9 +23,12 @@ characteristics:
repetition, enter '0' and the item will be repeated
forever.
-Notes:
- o repeated items are marked with an '*' inside the appointment
- panel, to be easily recognizable from non-repeated ones.
- o the 'Repeat' and 'Delete' command can be mixed to create
- complicated configurations, as it is possible to delete only
- one occurence of a repeated item. \ No newline at end of file
+Notes
+-----
+
+* Repeated items are marked with an '*' inside the appointment panel, to be
+ easily recognizable from non-repeated ones.
+
+* The 'Repeat' and 'Delete' command can be mixed to create complicated
+ configurations, as it is possible to delete only one occurence of a repeated
+ item.
diff --git a/doc/save.txt b/doc/save.txt
index d9d98a6..f1bcc84 100644
--- a/doc/save.txt
+++ b/doc/save.txt
@@ -2,6 +2,7 @@ Save
====
Save calcurse data.
+
Data are splitted into four different files which contain :
/ ~/.calcurse/conf -> user configuration
@@ -10,5 +11,5 @@ Data are splitted into four different files which contain :
| ~/.calcurse/todo -> data related to the todo list
\ ~/.calcurse/keys -> user-defined key bindings
-In the config menu, you can choose to save the Calcurse data
-automatically before quitting. \ No newline at end of file
+In the config menu, you can choose to save the Calcurse data automatically
+before quitting.
diff --git a/doc/tab.txt b/doc/tab.txt
index 58d1b21..8637696 100644
--- a/doc/tab.txt
+++ b/doc/tab.txt
@@ -2,13 +2,13 @@ Tab
===
Switch between panels.
+
The panel currently in use has its border colorized.
-Some actions are possible only if the right panel is selected.
-For example, if you want to add a task in the TODO list, you need first
-to press the 'TAB' key to get the TODO panel selected. Then you can
-press 'a' to add your item.
+Some actions are possible only if the right panel is selected. For example, if
+you want to add a task in the TODO list, you need first to press the 'TAB' key
+to get the TODO panel selected. Then you can press 'a' to add your item.
-Notice that at the bottom of the screen the list of possible actions
-change while pressing 'TAB', so you always know what action can be
-performed on the selected panel. \ No newline at end of file
+Notice that at the bottom of the screen the list of possible actions change
+while pressing 'TAB', so you always know what action can be performed on the
+selected panel.
diff --git a/doc/view.txt b/doc/view.txt
index 8122130..94df7f5 100644
--- a/doc/view.txt
+++ b/doc/view.txt
@@ -3,11 +3,10 @@ View
View the item you select in either the Todo or Appointment panel.
-This is usefull when an event description is longer than the available
-space to display it. If that is the case, the description will be
-shortened and its end replaced by '...'. To be able to read the entire
-description, just press 'v' and a popup window will appear, containing
-the whole event.
+This is usefull when an event description is longer than the available space to
+display it. If that is the case, the description will be shortened and its end
+replaced by '...'. To be able to read the entire description, just press 'v'
+and a popup window will appear, containing the whole event.
-Press any key to close the popup window and go back to the main
-Calcurse screen. \ No newline at end of file
+Press any key to close the popup window and go back to the main Calcurse
+screen.
diff --git a/doc/vnote.txt b/doc/vnote.txt
index b55eb7e..df6475f 100644
--- a/doc/vnote.txt
+++ b/doc/vnote.txt
@@ -1,16 +1,20 @@
ViewNote
========
-View a note which was previously attached to an item (an item which
-owns a note has a '>' sign in front of it).
-This command only permits to view the note, not to edit it (to do so,
-use the 'EditNote' command, by pressing the 'n' key).
-Once you highlighted an item with a note attached to it, and the '>' key
-was pressed, you will be driven to an external pager to view that note.
-The default pager is chosen the following way:
- o if the 'PAGER' environment variable is set, then this will be
- the default viewer to be called.
- o if the above environment variable is not set, then
- '/usr/bin/less' will be used.
-As for editing a note, quit the pager and you will be driven back to
-Calcurse. \ No newline at end of file
+View a note which was previously attached to an item (an item which owns a note
+has a '>' sign in front of it).
+
+This command only permits to view the note, not to edit it (to do so, use the
+'EditNote' command, by pressing the 'n' key).
+
+Once you highlighted an item with a note attached to it, and the '>' key was
+pressed, you will be driven to an external pager to view that note. The
+default pager is chosen the following way:
+
+* If the 'PAGER' environment variable is set, then this will be the default
+ viewer to be called.
+
+* If the above environment variable is not set, then '/usr/bin/less' will be
+ used.
+
+As for editing a note, quit the pager and you will be driven back to Calcurse.