← Back to branch summary

~conky-companions/+junk/conkyclementine

« back to all changes in this revision

Viewing changes to README

  • Committer: Mark
  • Date: 2010-12-14 16:36:53 UTC
  • Revision ID: mark@towerpc1-20101214163653-6v9i8ezczmdgzixu
Initial package

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
 
1
Authors: Mark Buck (Kaivalagi) <m_buck@hotmail.com>, Terry (VastOne) <vastone@gmail.com>
 
2
 
 
3
PREREQUISITES
 
4
=============
 
5
 
 
6
It is expected that the user is already familiar with Conky.
 
7
 
 
8
Any conky specific help can be found by either visiting the conky website here:
 
9
 
 
10
    http://conky.sourceforge.net
 
11
 
 
12
Alternatively there is a large user base, various helpful posts are available
 
13
at http://www.ubuntuforums.org
 
14
 
 
15
For example, to see various incarnations of conky setups, or to ask technical
 
16
questions you could go here:
 
17
    
 
18
        Post your .conkyrc files w/ screenshots
 
19
 
 
20
        http://ubuntuforums.org/showthread.php?t=281865 
 
21
 
 
22
If you are not familiar with conky there is help available here:
 
23
 
 
24
    HOW TO: A Beginners Guide to Setting up Conky
 
25
 
 
26
    http://ubuntuforums.org/showthread.php?t=867076
 
27
 
 
28
 
 
29
EXAMPLE USE
 
30
===========
 
31
 
 
32
In the /usr/share/conkyclementine/example folder you'll find 2 files, conkyrc and
 
33
conkyclementine.template
 
34
 
 
35
Conky can be run using these example files as follows:
 
36
 
 
37
    conky -c /usr/share/conkyclementine/example/conkyrc &
 
38
    
 
39
Make sure Clementine is running first...
 
40
 
 
41
 
 
42
COMMAND OPTIONS
 
43
===============
 
44
 
 
45
A break down of all the options available are below. The same details can be
 
46
found by running conkyClementine --help
 
47
 
 
48
Usage: conkyClementine [options]
 
49
Options:
 
50
  -h, --help            show this help message and exit
 
51
  -t FILE, --template=FILE
 
52
                        define a template file to generate output in one call.
 
53
                        A displayable item in the file is in the form
 
54
                        [--datatype=TI]. The following are possible options
 
55
                        within each item: --datatype,--ratingchar. Note that
 
56
                        the short forms of the options are not currently
 
57
                        supported! None of these options are applicable at
 
58
                        command line when using templates.
 
59
  -d DATATYPE, --datatype=DATATYPE
 
60
                        [default: TI] The data type options are: ST (status),
 
61
                        CA (coverart), TI (title), AL (album), AR (artist), GE
 
62
                        (genre), YR (year), TN (track number), FN (file name),
 
63
                        BR (bitrate k/s), LE (length), PP (current position in
 
64
                        percent), PT (current position in time), VO (volume),
 
65
                        RT (rating). Not applicable at command line when using
 
66
                        templates.
 
67
  -c PATH, --coverartpath=PATH
 
68
                        [default: /tmp/cover] The file where coverart gets
 
69
                        copied to if found when using the --datatype=CA
 
70
                        option. Note that if set to an empty string i.e. ""
 
71
                        the original file path is provided for the coverart
 
72
                        path.
 
73
  -r CHAR, --ratingchar=CHAR
 
74
                        [default: *] The output character for the ratings
 
75
                        scale. Command line option overridden if used in
 
76
                        templates.
 
77
  -s TEXT, --statustext=TEXT
 
78
                        [default: Playing,Paused,Stopped] The text must be
 
79
                        comma delimited in the form 'A,B,C'. Command line
 
80
                        option overridden if used in templates.
 
81
  -n, --nounknownoutput
 
82
                        Turn off unknown output such as "Unknown" for title
 
83
                        and "0:00" for length. Command line option overridden
 
84
                        if used in templates.
 
85
  -S, --secondsoutput   Force all position and length output to be in seconds
 
86
                        only.
 
87
  -m LENGTH, --maxlength=LENGTH
 
88
                        [default: 0] Define the maximum length of any
 
89
                        datatypes output, if truncated the output ends in
 
90
                        "..."
 
91
  -v, --verbose         Request verbose output, not a good idea when running
 
92
                        through conky!
 
93
  -V, --version         Displays the version of the script.
 
94
  --errorlogfile=FILE   If a filepath is set, the script appends errors to the
 
95
                        filepath.
 
96
  --infologfile=FILE    If a filepath is set, the script appends info to the
 
97
                        filepath.
 
98
 
 
99
 
 
100
TEMPLATE FILES
 
101
==============
 
102
 
 
103
A template file is included in the example files and there are also details on
 
104
the template option in the command options listed above.
 
105
 
 
106
Note that you can combine standard font output with other fonts in a single
 
107
template, but must use execp or execpi conky commands to do so.
 
108
 
 
109
Please take a look at the example template provided. You will see that anything
 
110
inside the square brackets are options, anything outside standard text that will
 
111
be output as conky would normally handle it.
 
112
 
 
113
 
 
114
FURTHER HELP
 
115
============
 
116
 
 
117
If you have an issue and are not sure, try running the same command in the
 
118
terminal window and add the option --verbose, you should then see lots of
 
119
information about what the script is doing, any warnings or errors should also
 
120
be displayed.
 
121
 
 
122
If after doing the above you are still stuck, further help can be found by 
 
123
visiting this thread on ubuntuforums.org:
 
124
 
 
125
        Conky Clementine Python Script
 
126
        
 
127
        http://ubuntuforums.org/showthread.php?t=????????
 
128
 
 
129
Note that it is best to post --verbose output of your script call, as well as
 
130
the conkyrc you are using. This way the issue can be understood quickly and
 
131
easily.
 
132
 
 
133
ENJOY :)
 
134
 
 
135