Download pdf - Conky Manual

Transcript
Page 1: Conky Manual

Varia

ble

Exp

lanatio

n

TE

XT

Afte

r this b

eg

ins te

xt to

be fo

rmatte

d o

n sc

reen

. Backsla

sh (\) e

scap

es

new

lines in

the te

xt se

ctio

n. T

his c

an

be u

sefu

l for c

lean

ing

up

con

fig file

sw

here

con

ky is u

sed

to p

ipe in

pu

t to d

zen

2.

alig

nm

en

t

Alig

ned

positio

n o

n sc

reen

, may b

e to

p_le

ft, top

_righ

t, top

_mid

dle

,b

otto

m_le

ft, botto

m_rig

ht, b

otto

m_m

idd

le, m

idd

le_le

ft, mid

dle

_mid

dle

,m

idd

le_rig

ht, o

r non

e (a

lso c

an

be a

bre

via

ted

as tl, tr, tm

, bl, b

r, bm

, ml,

mm

, mr). S

ee a

lso g

ap

_x a

nd

gap

_y.

ap

pen

d_file

Ap

pen

d th

e file

giv

en

as a

rgu

men

t.

backg

rou

nd

Boole

an

valu

e, if tru

e, C

on

ky w

ill be fo

rked

to b

ackg

rou

nd

wh

en

starte

d.

bord

er_in

ner_m

arg

inIn

ner b

ord

er m

arg

in in

pix

els (th

e m

arg

in b

etw

een

the b

ord

er a

nd

text).

bord

er_o

ute

r_marg

inO

ute

r bord

er m

arg

in in

pix

els (th

e m

arg

in b

etw

een

the b

ord

er a

nd

the

ed

ge o

f the w

ind

ow

).

bord

er_w

idth

Bord

er w

idth

in p

ixels.

colo

rNP

red

efin

e a

colo

r for u

se in

side T

EX

T se

gm

en

ts. Su

bstitu

te N

by a

dig

itb

etw

een

0 a

nd

9, in

clu

sively

. Wh

en

specify

ing

the c

olo

r valu

e in

hex, o

mit

the le

ad

ing

hash

(#).

cp

u_a

vg

_sam

ple

sT

he n

um

ber o

f sam

ple

s to a

vera

ge fo

r CP

U m

on

itorin

g.

defa

ult_b

ar_size

Sp

ecify

a d

efa

ult w

idth

an

d h

eig

ht fo

r bars. E

xam

ple

: 'defa

ult_b

ar_size

0 6

'.T

his is p

artic

ula

rly u

sefu

l for e

xecb

ar a

nd

execib

ar a

s they d

o n

ot ta

ke size

arg

um

en

ts.

defa

ult_c

olo

rD

efa

ult c

olo

r an

d b

ord

er c

olo

r

defa

ult_g

au

ge_size

Sp

ecify

a d

efa

ult w

idth

an

d h

eig

ht fo

r gau

ges. E

xam

ple

: 'defa

ult_g

au

ge_size

25

25

'. Th

is is partic

ula

rly u

sefu

l for e

xecg

au

ge a

nd

execig

au

ge a

s they d

on

ot ta

ke size

arg

um

en

ts

Confi

gura

tion S

ettin

gs

http

://conky.so

urc

efo

rge.n

et/c

onfi

g_se

ttings.h

tml

1 o

f 811/2

6/2

010 0

5:0

7 P

M

Page 2: Conky Manual

defa

ult_g

rap

h_size

Sp

ecify

a d

efa

ult w

idth

an

d h

eig

ht fo

r gra

ph

s. Exam

ple

: 'defa

ult_g

rap

h_size

0 2

5'. T

his is p

artic

ula

rly u

sefu

l for e

xecg

rap

h a

nd

execig

rap

h a

s they d

on

ot ta

ke size

arg

um

en

ts

defa

ult_o

utlin

e_c

olo

rD

efa

ult o

utlin

e c

olo

r

defa

ult_sh

ad

e_c

olo

rD

efa

ult sh

ad

ing

colo

r an

d b

ord

er's sh

ad

ing

colo

r

disa

ble

_au

to_re

load

En

ab

le to

disa

ble

the in

otify

-base

d a

uto

con

fig re

load

featu

re.

disk

io_a

vg

_sam

ple

sT

he n

um

ber o

f sam

ple

s to a

vera

ge fo

r disk

I/O m

on

itorin

g.

disp

lay

Sp

ecify

an

X d

ispla

y to

con

nect to

.

dou

ble

_bu

ffer

Use

the X

db

e e

xte

nsio

n? (e

limin

ate

s flicker) It is h

igh

ly re

com

men

ded

tou

se o

wn

win

dow

with

this o

ne so

dou

ble

bu

ffer w

on

't be so

big

.

dra

w_b

ord

ers

Dra

w b

ord

ers a

rou

nd

text?

dra

w_g

rap

h_b

ord

ers

Dra

w b

ord

ers a

rou

nd

gra

ph

s?

dra

w_o

utlin

eD

raw

ou

tlines?

dra

w_sh

ad

es

Dra

w sh

ad

es?

extra

_new

line

Pu

t an

extra

new

line a

t the e

nd

wh

en

writin

g to

stdou

t, use

ful fo

r writin

gto

aw

eso

me's w

iboxes.

fon

tF

on

t nam

e in

X, x

fon

tsel c

an

be u

sed

to g

et a

nic

e fo

nt

form

at_h

um

an

_read

ab

leIf e

nab

led

, valu

es w

hic

h a

re in

byte

s will b

e p

rinte

d in

hu

man

read

ab

lefo

rmat (i.e

., KiB

, MiB

, etc

). If disa

ble

d, th

e n

um

ber o

f byte

s is prin

ted

inste

ad

.

gap

_xG

ap

, in p

ixels, b

etw

een

righ

t or le

ft bord

er o

f scre

en

, sam

e a

s passin

g -x

at

com

man

d lin

e, e

.g. g

ap

_x 1

0. F

or o

ther p

ositio

n re

late

d stu

ff, see

'alig

nm

en

t'.

gap

_yG

ap

, in p

ixels, b

etw

een

top

or b

otto

m b

ord

er o

f scre

en

, sam

e a

s passin

g -y

at c

om

man

d lin

e, e

.g. g

ap

_y 1

0. F

or o

ther p

ositio

n re

late

d stu

ff, see

Confi

gura

tion S

ettin

gs

http

://conky.so

urc

efo

rge.n

et/c

onfi

g_se

ttings.h

tml

2 o

f 811/2

6/2

010 0

5:0

7 P

M

Page 3: Conky Manual

'alig

nm

en

t'.

hd

dte

mp

_host

Hostn

am

e to

con

nect to

for h

dd

tem

p o

bje

cts. D

efa

ults to

"12

7.0

.0.1

".

hd

dte

mp

_port

Port to

use

for h

dd

tem

p c

on

nectio

ns. D

efa

ults to

76

34

.

if_up

_strictn

ess

How

strict sh

ou

ld if_u

p b

e w

hen

testin

g a

n in

terfa

ce fo

r bein

g u

p? T

he

valu

e is o

ne o

f up

, link o

r ad

dre

ss, to c

heck fo

r the in

terfa

ce b

ein

g so

lely

up

, bein

g u

p a

nd

havin

g lin

k o

r bein

g u

p, h

avin

g lin

k a

nd

an

assig

ned

IPad

dre

ss.

imap

Defa

ult g

lob

al IM

AP

serv

er. A

rgu

men

ts are

: "host u

ser p

ass [-i in

terv

al (in

secon

ds)] [-f 'fo

lder'] [-p

port] [-e

'com

man

d'] [-r re

tries]". D

efa

ult p

ort is

14

3, d

efa

ult fo

lder is 'IN

BO

X', d

efa

ult in

terv

al is 5

min

ute

s, an

d d

efa

ult

nu

mb

er o

f retrie

s befo

re g

ivin

g u

p is 5

. If the p

assw

ord

is sup

plie

d a

s '*',you

will b

e p

rom

pte

d to

en

ter th

e p

assw

ord

wh

en

Con

ky sta

rts.

imlib

_cach

e_flu

sh_in

terv

al

Inte

rval (in

secon

ds) to

flush

Imlib

2 c

ach

e.

imlib

_cach

e_size

Imlib

2 im

ag

e c

ach

e size

, in b

yte

s. Defa

ults to

4M

iB. In

cre

ase

this v

alu

e if

you

use

$im

ag

e lo

ts. Set to

0 to

disa

ble

the im

ag

e c

ach

e.

lua_d

raw

_hook_p

ost

Th

is fun

ctio

n, if d

efin

ed

, will b

e c

alle

d b

y C

on

ky th

rou

gh

each

itera

tion

afte

r dra

win

g to

the w

ind

ow

. Req

uire

s X su

pp

ort. T

akes a

ny n

um

ber o

fop

tion

al a

rgu

men

ts. Use

this h

ook fo

r dra

win

g th

ing

s on

top

of w

hat C

on

ky

dra

ws. C

on

ky p

uts 'c

on

ky_' in

fron

t of fu

nctio

n_n

am

e to

pre

ven

t accid

en

tal

calls to

the w

ron

g fu

nctio

n u

nle

ss you

pla

ce 'c

on

ky_' in

fron

t of it y

ou

rself.

lua_d

raw

_hook_p

re

Th

is fun

ctio

n, if d

efin

ed

, will b

e c

alle

d b

y C

on

ky th

rou

gh

each

itera

tion

befo

re d

raw

ing

to th

e w

ind

ow

. Req

uire

s X su

pp

ort. T

akes a

ny n

um

ber o

fop

tion

al a

rgu

men

ts. Use

this h

ook fo

r dra

win

g th

ing

s on

top

of w

hat C

on

ky

dra

ws. C

on

ky p

uts 'c

on

ky_' in

fron

t of fu

nctio

n_n

am

e to

pre

ven

t accid

en

tal

calls to

the w

ron

g fu

nctio

n u

nle

ss you

pla

ce 'c

on

ky_' in

fron

t of it y

ou

rself.

lua_lo

ad

Load

s the L

ua sc

ripts se

para

ted

by sp

aces.

lua_sh

utd

ow

n_h

ook

Th

is fun

ctio

n, if d

efin

ed

, will b

e c

alle

d b

y C

on

ky a

t shu

tdow

n o

r wh

en

the

Confi

gura

tion S

ettin

gs

http

://conky.so

urc

efo

rge.n

et/c

onfi

g_se

ttings.h

tml

3 o

f 811/2

6/2

010 0

5:0

7 P

M

Page 4: Conky Manual

con

figu

ratio

n is re

load

ed

. Use

this h

ook to

cle

an

up

afte

r you

rself, su

ch

as

freein

g m

em

ory

wh

ich

has b

een

allo

cate

d b

y e

xte

rnal lib

rarie

s via

Lu

a.

Con

ky p

uts 'c

on

ky_' in

fron

t of fu

nctio

n_n

am

e to

pre

ven

t accid

en

tal c

alls to

the w

ron

g fu

nctio

n u

nle

ss you

pla

ce 'c

on

ky_' in

fron

t of it y

ou

rself.

lua_sta

rtup

_hook

Th

is fun

ctio

n, if d

efin

ed

, will b

e c

alle

d b

y C

on

ky a

t startu

p o

r wh

en

the

con

figu

ratio

n is re

load

ed

. Use

this h

ook to

initia

lize v

alu

es, o

r for a

ny

run

-on

ce a

pp

licatio

ns. C

on

ky p

uts 'c

on

ky_' in

fron

t of fu

nctio

n_n

am

e to

pre

ven

t accid

en

tal c

alls to

the w

ron

g fu

nctio

n u

nle

ss you

pla

ce 'c

on

ky_' in

fron

t of it y

ou

rself.

mail_sp

ool

Mail sp

ool fo

r mail c

heckin

g

max_p

ort_m

on

itor_c

on

nectio

ns

Allo

w e

ach

port m

on

itor to

track a

t most th

is man

y c

on

nectio

ns (if 0

or n

ot

set, d

efa

ult is 2

56

)

max_sp

ecia

lsM

axim

um

nu

mb

er o

f specia

l thin

gs, e

.g. fo

nts, o

ffsets, a

lign

s, etc

. (defa

ult

is 51

2)

max_te

xt_w

idth

Wh

en

a lin

e in

the o

utp

ut c

on

tain

s 'wid

th' c

hars a

nd

the e

nd

isn't re

ach

ed

,th

e n

ext c

har w

ill start o

n a

new

line. If y

ou

wan

t to m

ake su

re th

at lin

es

don

't get b

roken

, set 'w

idth

' to 0

max_u

ser_te

xt

Maxim

um

size o

f use

r text b

uffe

r, i.e. la

you

t belo

w T

EX

T lin

e in

con

fig file

(defa

ult is 1

63

84

byte

s)

maxim

um

_wid

thM

axim

um

wid

th o

f win

dow

min

imu

m_size

Min

imu

m size

of w

ind

ow

mp

d_h

ost

Host o

f MP

D se

rver

mp

d_p

assw

ord

MP

D se

rver p

assw

ord

mp

d_p

ort

Port o

f MP

D se

rver

mu

sic_p

layer_in

terv

al

Mu

sic p

layer th

read

up

date

inte

rval (d

efa

ults to

Con

ky's u

pd

ate

inte

rval)

net_a

vg

_sam

ple

sT

he n

um

ber o

f sam

ple

s to a

vera

ge fo

r net d

ata

Confi

gura

tion S

ettin

gs

http

://conky.so

urc

efo

rge.n

et/c

onfi

g_se

ttings.h

tml

4 o

f 811/2

6/2

010 0

5:0

7 P

M

Page 5: Conky Manual

no_b

uffe

rsS

ub

tract (file

syste

m) b

uffe

rs from

use

d m

em

ory

?

nvid

ia_d

ispla

yT

he d

ispla

y th

at th

e n

vid

ia v

aria

ble

will u

se (d

efa

ults to

the v

alu

e o

f the

disp

lay v

aria

ble

)

ou

t_to_c

on

sole

Prin

t text to

stdou

t.

ou

t_to_n

cu

rses

Prin

t text in

the c

on

sole

, bu

t use

ncu

rses so

that c

on

ky c

an

prin

t the te

xt o

fa n

ew

up

date

over th

e o

ld te

xt. (In

the fu

ture

this w

ill pro

vid

e m

ore

use

ful

thin

gs)

ou

t_to_std

err

Prin

t text to

stderr.

ou

t_to_x

Wh

en

set to

no, th

ere

will b

e n

o o

utp

ut in

X (u

sefu

l wh

en

you

also

use

thin

gs lik

e o

ut_to

_con

sole

). If you

set it to

no, m

ake su

re th

at it's p

laced

befo

re a

ll oth

er X

-rela

ted

settin

g (ta

ke th

e first lin

e o

f you

r con

figfile

to b

esu

re). D

efa

ult v

alu

e is y

es

overrid

e_u

tf8_lo

cale

Forc

e U

TF

8? re

qu

ires X

FT

overw

rite_file

Overw

rite th

e file

giv

en

as a

rgu

men

t.

ow

n_w

ind

ow

Boole

an

, cre

ate

ow

n w

ind

ow

to d

raw

?

ow

n_w

ind

ow

_cla

ssM

an

ually

set th

e W

M_C

LA

SS

nam

e. D

efa

ults to

"Con

ky".

ow

n_w

ind

ow

_colo

ur

If ow

n_w

ind

ow

_tran

spare

nt n

o, se

t a sp

ecifie

d b

ackg

rou

nd

colo

ur (d

efa

ults

to b

lack). T

akes e

ither a

hex v

alu

e (e

.g. ffffff, n

ote

the la

ck o

f '#') o

r a v

alid

RG

B n

am

e (se

e /u

sr/lib/X

11

/rgb

.txt)

ow

n_w

ind

ow

_hin

ts

If ow

n_w

ind

ow

is yes, y

ou

may u

se th

ese

win

dow

man

ag

er h

ints to

affe

ct

the w

ay C

on

ky d

ispla

ys. N

ote

s: Use

ow

n_w

ind

ow

_typ

e d

esk

top

as a

noth

er

way to

imp

lem

en

t man

y o

f these

hin

ts imp

licitly

. If you

use

ow

n_w

ind

ow

_typ

e o

verrid

e, w

ind

ow

man

ag

er h

ints h

ave n

o m

ean

ing

an

dare

ign

ore

d.

ow

n_w

ind

ow

_titleM

an

ually

set th

e w

ind

ow

nam

e. D

efa

ults to

"<h

ostn

am

e>

- con

ky".

Confi

gura

tion S

ettin

gs

http

://conky.so

urc

efo

rge.n

et/c

onfi

g_se

ttings.h

tml

5 o

f 811/2

6/2

010 0

5:0

7 P

M

Page 6: Conky Manual

ow

n_w

ind

ow

_arg

b_v

isual

Boole

an

, use

AR

GB

visu

al? A

RG

B c

an

be u

sed

for re

al tra

nsp

are

ncy, n

ote

that a

com

posite

man

ag

er is re

qu

ired

for re

al tra

nsp

are

ncy. T

his o

ptio

n w

illn

ot w

ork

as d

esire

d (in

most c

ase

s) in c

on

jun

ctio

n w

ith 'o

wn

_win

dow

_typ

eoverrid

e'.

ow

n_w

ind

ow

_arg

b_v

alu

eW

hen

AR

GB

visu

als a

re e

nab

led

, this u

se th

is to m

od

ify th

e a

lph

a v

alu

eu

sed

. Valid

ran

ge is 0

-25

5, w

here

0 is 0

% o

pacity

, an

d 2

55

is 10

0%

op

acity

.

ow

n_w

ind

ow

_tran

spare

nt

Boole

an

, set tra

nsp

are

ncy? If A

RG

B v

isual is e

nab

led

, sets b

ackg

rou

nd

op

acity

to 0

%.

ow

n_w

ind

ow

_typ

e

if ow

n_w

ind

ow

is yes, y

ou

may sp

ecify

typ

e n

orm

al, d

esk

top

, dock, p

an

el o

roverrid

e (d

efa

ult: n

orm

al). D

esk

top

win

dow

s are

specia

l win

dow

s that h

ave

no w

ind

ow

decora

tion

s; are

alw

ays v

isible

on

you

r desk

top

; do n

ot a

pp

ear

in y

ou

r pag

er o

r task

bar; a

nd

are

sticky a

cro

ss all w

ork

spaces. P

an

el

win

dow

s rese

rve sp

ace a

lon

g a

desk

top

ed

ge, ju

st like p

an

els a

nd

task

bars,

pre

ven

ting

maxim

ized

win

dow

s from

overla

pp

ing

them

. Th

e e

dg

e is c

hose

nb

ase

d o

n th

e a

lign

men

t op

tion

. Overrid

e w

ind

ow

s are

not u

nd

er th

e c

on

trol

of th

e w

ind

ow

man

ag

er. H

ints a

re ig

nore

d. T

his ty

pe o

f win

dow

can

be

use

ful fo

r certa

in situ

atio

ns.

pad

_perc

en

tsP

ad

perc

en

tag

es to

this m

an

y d

ecim

als (0

= n

o p

ad

din

g)

pop

3

Defa

ult g

lob

al P

OP

3 se

rver. A

rgu

men

ts are

: "host u

ser p

ass [-i in

terv

al (in

secon

ds)] [-p

port] [-e

'com

man

d'] [-r re

tries]". D

efa

ult p

ort is 1

10

, defa

ult

inte

rval is 5

min

ute

s, an

d d

efa

ult n

um

ber o

f retrie

s befo

re g

ivin

g u

p is 5

. Ifth

e p

assw

ord

is sup

plie

d a

s '*', you

will b

e p

rom

pte

d to

en

ter th

e p

assw

ord

wh

en

Con

ky sta

rts.

short_u

nits

Sh

orte

ns u

nits to

a sin

gle

ch

ara

cte

r (kiB

->k, G

iB->

G, e

tc.). D

efa

ult is o

ff.

show

_gra

ph

_ran

ge

Sh

ow

s the tim

e ra

ng

e c

overe

d b

y a

gra

ph

.

show

_gra

ph

_scale

Sh

ow

s the m

axim

um

valu

e in

scale

d g

rap

hs.

stipp

led

_bord

ers

Bord

er stip

plin

g (d

ash

ing

) in p

ixels

Confi

gura

tion S

ettin

gs

http

://conky.so

urc

efo

rge.n

et/c

onfi

g_se

ttings.h

tml

6 o

f 811/2

6/2

010 0

5:0

7 P

M

Page 7: Conky Manual

tem

pera

ture

_un

itD

esire

d o

utp

ut u

nit o

f all o

bje

cts d

ispla

yin

g a

tem

pera

ture

. Para

mete

rs are

eith

er "fa

hre

nh

eit" o

r "celsiu

s". Th

e d

efa

ult u

nit is d

eg

ree C

elsiu

s.

tem

pla

teN

Defin

e a

tem

pla

te fo

r late

r use

insid

e T

EX

T se

gm

en

ts. Su

bstitu

te N

by a

dig

it betw

een

0 a

nd

9, in

clu

sively

. Th

e v

alu

e o

f the v

aria

ble

is bein

gin

serte

d in

to th

e stu

ff belo

w T

EX

T a

t the c

orre

spon

din

g p

ositio

n, b

ut

befo

re so

me su

bstitu

tion

s are

ap

plie

d:

'\n' ->

new

line

'\\' -> b

acksla

sh'\ ' ->

space

'\N' ->

tem

pla

te a

rgu

men

t N

text_b

uffe

r_size

Size

of th

e sta

nd

ard

text b

uffe

r (defa

ult is 2

56

byte

s). Th

is bu

ffer is u

sed

for in

term

ed

iary

text, su

ch

as in

div

idu

al lin

es, o

utp

ut fro

m $

exec v

ars, a

nd

vario

us o

ther v

aria

ble

s. Incre

asin

g th

e size

of th

is bu

ffer c

an

dra

stically

red

uce C

on

ky's p

erfo

rman

ce, b

ut w

ill allo

w fo

r more

text d

ispla

y p

er

varia

ble

. Th

e size

of th

is bu

ffer c

an

not b

e sm

alle

r than

the d

efa

ult v

alu

e o

f2

56

byte

s.

times_in

_secon

ds

If true, v

aria

ble

s that o

utp

ut tim

es o

utp

ut a

nu

mb

er th

at re

pre

sen

tsse

con

ds. T

his d

oesn

't affe

ct $

time, $

tztime a

nd

$u

time

top

_cp

u_se

para

teIf tru

e, c

pu

in to

p w

ill show

usa

ge o

f on

e p

rocesso

r's pow

er. If fa

lse, c

pu

into

p w

ill show

the u

sag

e o

f all p

rocesso

rs' pow

er c

om

bin

ed

.

top

_nam

e_w

idth

Wid

th fo

r $to

p n

am

e v

alu

e (d

efa

ults to

15

ch

ara

cte

rs).

tota

l_run

_times

Tota

l nu

mb

er o

f times fo

r Con

ky to

up

date

befo

re q

uittin

g. Z

ero

makes

Con

ky ru

n fo

rever

up

date

_inte

rval

Up

date

inte

rval

up

date

_inte

rval_o

n_b

atte

ryU

pd

ate

inte

rval w

hen

run

nin

g o

n b

atte

ryp

ow

er

up

perc

ase

Boole

an

valu

e, if tru

e, te

xt is re

nd

ere

d in

up

per c

ase

Confi

gura

tion S

ettin

gs

http

://conky.so

urc

efo

rge.n

et/c

onfi

g_se

ttings.h

tml

7 o

f 811/2

6/2

010 0

5:0

7 P

M

Page 8: Conky Manual

use

_spacer

Ad

ds sp

aces a

rou

nd

certa

in o

bje

cts to

stop

them

from

movin

g o

ther th

ing

saro

un

d. A

rgu

men

ts are

left, rig

ht, a

nd

non

e (d

efa

ult). T

he o

ld tru

e/fa

lsevalu

es a

re d

ep

recate

d a

nd

defa

ult to

righ

t/non

e re

spectiv

ely

. Note

that th

ison

ly h

elp

s if you

are

usin

g a

mon

o fo

nt, su

ch

as B

itstream

Vera

San

s Mon

o.

use

_xft

Use

Xft (a

nti-a

liase

d fo

nt a

nd

stuff)

xfta

lph

aA

lph

a o

f Xft fo

nt. M

ust b

e a

valu

e a

t or b

etw

een

1 a

nd

0.

xftfo

nt

Xft fo

nt to

use

.

Confi

gura

tion S

ettin

gs

http

://conky.so

urc

efo

rge.n

et/c

onfi

g_se

ttings.h

tml

8 o

f 811/2

6/2

010 0

5:0

7 P

M


Recommended