← Back to branch summary

~ubuntu-branches/debian/sid/tickr/sid

« back to all changes in this revision

Viewing changes to src/tickr/tickr_helptext.c

  • Committer: Package Import Robot
  • Author(s): Emmanuel Thomas-Maurin
  • Date: 2012-06-04 14:23:24 UTC
  • mfrom: (1.1.4)
  • Revision ID: package-import@ubuntu.com-20120604142324-j6ycu0cw6vvoahhy
Tags: 0.6.1-1
* Add: 'quick setup' thing (in tickr_quicksetup.c) which is launched
  at program startup if config file doesn't exist.

* Little improvements in layout of 'feed picker win' and 'preferences
  win'.

* Fix a segfault that happens when trying to export params and no
  config file exists yet.

* Make several windows that should not be resized by user, unresizable.

* Fix Launchpad bug #1007346: When 'window always-on-top' is disabled,
  'visible on all user desktops' stops working.

* If mouse wheel scrolling applies to speed (or feed), then Ctrl +
  mouse wheel scrolling applies to feed (or speed.)

* No real code changes in libetm, only in comments, so no need for a
  new version number.

* Update tickr_helptext.c and tickr.1 (man page.)

* Add new cli option 'no-ui' (similar to 'instance-id') used by new
  IF_UI_ALLOWED macro and remove all #if USE_GUI occurences.

* In tickr_list.c, free listfname before using it. Fixed by swapping 2
  lines:
    warning(FALSE, 4, "Can't save URL list ", listfname, ...);
    l_str_free(listfname);

* Use/add #define
    FONT_MAXLEN         68
    ARBITRARY_TASKBAR_HEIGHT    25
  to replace a few 'magic' numeric values.

* Rename: rss_title/description(_delimiter) ->
    item_title/description(_delimiter)
  then add new param: feed_title(_delimiter). Now we have:
  feed title / item title / item description.

* Use table in resource properties window.

* Fix a bug in f_list_load_from_file() in tickr_list.c which
  uncorrectly retrieves any feed title string containing TITLE_TAG_CHAR
  when TITLE_TAG_CHAR has not been removed from string first, for
  instance: 'NYT > World' -> ' World'.

* New param: disable left-click.

* Add 'check for updates' feature.

* Launch 'import OPML file' if feed list doesn't exist.

* Remove code changing get_params()->disable_popups value in
    START/END_PAUSE_TICKER_WHILE_OPENING
  macros which prevents this setting to be saved and add
    START/END_PAUSE_TICKER_ENABLE_POPUPS_WHILE_OPENING
  new macros. Which ones to use depends on context.

* Move:
    #ifdef G_OS_WIN32
    extern FILE *stdout_fp, *stderr_fp;
    #endif
  from *.c into tickr.h.

* Default always-on-top setting changed to 'n' (so that tickr is not
  intrusive by default.)

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/tickr/tickr_helptext.c
18
18
 
19
19
#include "tickr.h"
20
20
 
21
 
#if USE_GUI
22
21
static const char *help_str0[] = {
23
 
"USER INTERFACE MAIN FEATURES: \n\n",
24
 
 
25
 
"- To open the main menu, right-click inside the ticker area.\n\n",
26
 
 
27
 
"- To open a link in your Browser, left-click on the text.\n\n",
28
 
 
29
 
"Basically, you will use 'File > Open Feed (RSS|Atom)' to choose a feed from a list\n",
30
 
"or to subscribe to a new one and 'Edit > Preferences' to tweak the ticker\n",
31
 
"appearance as well as other settings.\n\n",
 
22
"USER INTERFACE MAIN FEATURES:\n\n",
 
23
 
 
24
"- To open the main menu, right-click inside ticker area.\n\n",
 
25
 
 
26
"- You can import feed subscriptions with 'File > Import Feed List (OPML)',\n",
 
27
"for instance your Google Reader subscriptions.\n\n",
 
28
 
 
29
"- To open a link in your browser, left-click on text.\n\n",
 
30
 
 
31
"- Use mouse wheel to either adjust the ticker scrolling speed or open the\n",
 
32
"'Selected Feed Picker' window to quickly move between selected feeds (if set,\n",
 
33
"Ctrl + mouse wheel scrolling applies to other value.)\n",
 
34
"This behaviour is set in the 'Preferences' window as 'Mouse wheel scrolling\n",
 
35
"applies to'.\n\n",
 
36
 
 
37
"- Basically, you will use 'File > Open RSS Feed' to choose a feed from a\n",
 
38
"list, subscribe to a new one, manage your feed list, and 'Edit > Preferences'\n",
 
39
"to tweak the ticker appearance as well as other settings.\n\n",
 
40
 
 
41
"- 'Window - always on top' -> check this if you want the ticker to always\n",
 
42
"stay above your browser (and any other windows.)\n\n",
 
43
 
 
44
"- 'Window - decorated' -> if you want a 'draggable' ticker.\n\n",
 
45
 
 
46
"There is a sample list of already subscribed feeds that you can use.\n\n",
32
47
 
33
48
"***ONLY*** in case you're using the ticker inside a ***decorated*** window,\n",
34
 
"you can use keyboard shortcuts:\n\n",
 
49
"you can use these keyboard shortcuts:\n\n",
35
50
 
36
 
"- <Ctrl>R to open the Feed Picker window (to choose a feed or to\n",
37
 
"  subscribe to a new one.)\n\n",
 
51
"- <Ctrl>R to open the 'RSS Feed Picker' window (to choose a feed or to\n",
 
52
"subscribe to a new one.)\n\n",
38
53
 
39
54
"- <Ctrl>T to open a text file.\n\n",
40
55
 
41
 
"- <Ctrl>I to import feed list in OPML format.\n\n",
42
 
 
43
 
"- <Ctrl>E to export feed list in OPML format.\n\n",
44
 
 
45
 
"- <Ctrl>P to open the Resource Properties window.\n\n",
 
56
"- <Ctrl>I to import (and merge) an URL list from an OPML file.\n\n",
 
57
 
 
58
"- <Ctrl>E to export the URL list to an OPML file.\n\n",
 
59
 
 
60
"- <Ctrl>P to open the 'Resource Properties' window.\n\n",
46
61
 
47
62
"- <Ctrl>Q to quit.\n\n",
48
63
 
49
 
"- <Ctrl>S to open the Preferences (settings) window.\n\n",
 
64
"- <Ctrl>S to open the 'Preferences' (Settings) window.\n\n",
50
65
 
51
66
"- <Ctrl>B to open the link displayed inside the ticker (in the middle.)\n\n",
52
67
 
53
68
"- <Ctrl>J to play the feed / <Ctrl>K to pause / <Ctrl>L to reload.\n\n",
54
69
 
55
 
"- <Ctrl>U (speed Up) / <Ctrl>D (speed Down) to adjust scrolling speed on\n",
56
 
"  the fly.\n\n",
57
 
 
58
 
"- F1 to open the Quick Help window.\n\n",
59
 
 
60
 
"- <Ctrl>H to launch the Online Help.\n\n",
61
 
 
62
 
"- <Ctrl>A to open the About window and the License window.\n\n",
63
 
 
64
 
"After install, you can set up 2 quite useful parameters in the\n",
65
 
"Preferences window (<Ctrl>P):\n\n",
66
 
 
67
 
"- Window - always on top -> uncheck this if you don't want the ticker\n",
68
 
"  to always stay above the browser (and the other windows.)\n\n",
69
 
 
70
 
"- Window - decorated -> convenient if you want a 'draggable' ticker.\n\n\n",
71
 
 
 
70
"- <Ctrl>U (speed Up) / <Ctrl>D (speed Down) to adjust tscrolling speed on\n",
 
71
"the fly.\n\n",
 
72
 
 
73
"- F1 to open the 'Quick Help' window.\n\n",
 
74
 
 
75
"- <Ctrl>H to launch the 'Online Help' (this very page.)\n\n",
 
76
 
 
77
"- <Ctrl>A to open the 'About' window and the License window.\n\n\n",
72
78
 
73
79
"COMMAND LINE REFERENCE:\n\n",
74
80
 
75
81
NULL};
76
 
#endif
77
82
 
78
83
static const char *help_str1[] = {
79
84
        APP_NAME"-"APP_VERSION_NUMBER" - GTK-based highly graphically-customizable Feed Ticker\n",
82
87
        "scrolling line on your Desktop, as known from TV stations. Open feed\n"
83
88
        "links in your favourite Browser. Graphics are highly customizable.\n\n"
84
89
        "Usage:\n",
85
 
        "        "APP_CMD" [-help / -version / -license / -instance-id=n / -dumpfontlist]\n",
 
90
        "        "APP_CMD" [-help/-version/-license/-instance-id=n/-no-ui/-dumpfontlist]\n",
86
91
        "              [options (-name[=value])...] [resource (file name or URL)]\n\n",
87
92
        "        help                           Get this help page\n\n",
88
93
        "        version                        Print out version number\n\n",
92
97
        "                                       instance using its own config and dump\n",
93
98
        "                                       files (to be effective, instance-id must\n",
94
99
        "                                       be the 1st argument)\n\n",
 
100
        "        no-ui                          Disable opening of UI elements which can\n",
 
101
        "                                       modify settings and/or URL list/\n",
 
102
        "                                       selection\n\n",
95
103
        "        dumpfontlist                   Send list of available fonts to stdout\n\n",
96
104
        "Options:\n",
97
105
        "        delay=n                        Delay in milliseconds\n\n",
116
124
        "        shadowfx=n                     Shadow effect (0 = none -> 10 = full)\n\n",
117
125
        "        linedelimiter='str'            String to be appended at end of line\n\n",
118
126
        "        cutlinedelimiter='str'         String to be appended after a cut line\n\n",
 
127
        "        specialchars=[y/n]             Enable or disable special characters.\n",
 
128
        "                                       This is only useful when resource is a\n",
 
129
        "                                       file, not an URL\n\n",
 
130
        "        newpgchar=c                    'New page' special character\n\n",
 
131
        "        tabchar=c                      'Tab' (8 spaces) special character\n\n",
119
132
        "        rssrefresh=n                   Refresh rate in minutes (if no TTL\n",
120
133
        "                                       inside feed / always applies for files)\n\n",
121
 
        "        rsstitle=[y/n]                 Show or hide title\n\n",
122
 
        "        rsstitledelimiter='str'        String to be appended after title\n\n",
123
 
        "        rssdescription=[y/n]           Show or hide description\n\n",
124
 
        "        rssdescriptiondelimiter='str'  String to be appended after description\n\n",
 
134
        "        feedtitle=[y/n]                Show or hide feed title\n\n",
 
135
        "        feedtitledelimiter='str'       String to be appended after feed title\n\n",
 
136
        "        itemtitle=[y/n]                Show or hide item title\n\n",
 
137
        "        itemtitledelimiter='str'       String to be appended after item title\n\n",
 
138
        "        itemdescription=[y/n]          Show or hide item description\n\n",
 
139
        "        itemdescriptiondelimiter='str' String to be appended after item\n",
 
140
        "                                       description\n\n",
125
141
        "        nitemsperfeed=n                Read N items max per feed\n\n",
126
142
        "        rmtags=[y/n]                   Strip html tags\n\n",
127
143
        "        uppercasetext=[y/n]            Set all text to upper case\n\n",
141
157
        "        clockbgcolor=#rrggbbaa         Clock background 32-bit hexa color\n\n",
142
158
        "        disablepopups=[y/n]            Disable error/warning popup windows\n\n",
143
159
        "        pauseonmouseover=[y/n]         Pause ticker on mouseover\n\n",
144
 
        "        mousewheelscroll=[s/f/n]       Mouse wheel scrolling apply to:\n",
145
 
        "                                       (ticker-)speed / feed(-in-list) / none\n\n",
146
 
        "        specialchars=[y/n]             Enable or disable special characters.\n",
147
 
        "                                       This is only useful when resource is a\n",
148
 
        "                                       file, not an URL\n\n",
149
 
        "        newpgchar=c                    'new page' special character\n\n",
150
 
        "        tabchar=c                      'tab' (8 spaces) special character\n\n",
 
160
        "        disableleftclick=[y/n]         Disable left-click\n\n",
 
161
        "        mousewheelscroll=[s/f/n]       Mouse wheel scrolling applies to:\n",
 
162
        "                                       (ticker-)speed / feed(-in-list) / none\n",
 
163
        "                                       (if set, Ctrl + mouse wheel scrolling\n",
 
164
        "                                       applies to other value)\n\n",
151
165
        "        useauth=[y/n]                  Use HTTP basic authentication\n\n",
152
166
        "        user='str'                     User\n\n",
153
167
        "        psw='str'                      Password (never saved)\n\n",
157
171
        "        useproxyauth=[y/n]             Use proxy authentication\n\n",
158
172
        "        proxyuser='str'                Proxy user\n\n",
159
173
        "        proxypsw='str'                 Proxy password (never saved)\n\n",
 
174
        "Mouse usage:\n"
 
175
        "        To open the main menu, right-click inside ticker area.\n\n",
 
176
        "        You can import feed subscriptions from another feed reader with\n",
 
177
        "        'File > Import Feed List (OPML)'.\n\n",
 
178
        "        To open a link in your browser, left-click on text.\n\n",
 
179
        "        Use mouse wheel to either adjust ticker scrolling speed or open the\n",
 
180
        "        'Selected Feed Picker' window to quickly move between selected feeds\n",
 
181
        "        (and use Ctrl + mouse wheel for the other option.)\n\n",
160
182
        "The default browser is Firefox on Linux. You may change this setting to your\n",
161
183
        "favourite one in the Preferences window.\n\n",
162
 
        "You can open a link by clicking the text inside the ticker. Alternatively, with\n",
163
 
        "a decorated window, you can type <Ctrl>B. When doing so, be aware that the link\n",
164
 
        "to be open will be the one related to the text located in the middle of the\n",
165
 
        "ticker area.\n\n",
166
184
        APP_NAME" parses command line arguments and looks for option(s) then for one\n",
167
185
        "resource, the rest of the line is ignored. It reads too configuration file\n",
168
186
#ifndef G_OS_WIN32
175
193
        "Command line options override configuration file ones which override default\n",
176
194
        "ones.\n\n",
177
195
        "Compiled with GTK+ and Libxml2 on "__DATE__" - "__TIME__"\n",
178
 
        "\nVisit "APP_WEBSITE" for more info.\n",
 
196
        "\nVisit "WEBSITE_URL" for more info.\n",
179
197
        NULL};
180
198
 
181
199
static const char *license_str1[] = {
195
213
static const char *license_str2 =
196
214
        "http://www.gnu.org/licenses/\n";
197
215
 
198
 
#if USE_GUI
199
216
const char** get_help_str0()
200
217
{
201
218
        return help_str0;
202
219
}
203
 
#endif
204
220
 
205
221
const char** get_help_str1()
206
222
{