~ubuntu-branches/debian/sid/conky/sid : revision 21

1

<html>

2

<head>

3

4

<title>Conky Variables</title>

4

<title>Conky Objects</title>

5

</head>

6

7

11

</tr>

12

13

<td align="center">acpiacadapter</td>

14

15

<td>ACPI ac adapter state.

16

</td>

14

<td align="center">(adapter)</td>

15

<td>ACPI ac adapter state. On linux, the adapter option specifies the

16

subfolder of /sys/class/power_supply containing the state information (defaults

17

to "AC"). Other systems ignore it.

18

19

</td>

17

20

</tr>

18

21

19

22

<td align="center">acpifan</td>

20

23

21

24

<td>ACPI fan state

22

</td>

25

26

</td>

23

27

</tr>

24

28

25

29

<td align="center">acpitemp</td>

26

30

27

31

<td>ACPI temperature in C.

28

</td>

32

33

</td>

29

34

</tr>

30

35

31

36

32

<td align="center">interface</td>

37

<td align="center">(interface)</td>

33

38

<td>IP address for an interface, or "No Address" if

34

39

no address is assigned.

35

</td>

40

41

</td>

36

42

</tr>

37

43

38

44

<td align="center">addrs</td>

39

<td align="center">interface</td>

45

<td align="center">(interface)</td>

40

46

<td>IP addresses for an interface (if one - works

41

47

like addr). Linux only.

42

</td>

48

49

</td>

43

50

</tr>

44

51

45

52

46

53

47

54

<td>CPU temperature from therm_adt746x

48

</td>

55

56

</td>

49

57

</tr>

50

58

51

59

52

60

53

61

<td>Fan speed from therm_adt746x

54

</td>

62

63

</td>

55

64

</tr>

56

65

57

66

<td align="center">alignc</td>

58

67

59

68

<td>Align text to centre

60

</td>

69

70

</td>

61

71

</tr>

62

72

63

73

<td align="center">alignr</td>

64

74

65

75

<td>Right-justify text, with space of N

66

</td>

76

77

</td>

67

78

</tr>

68

79

69

80

<td align="center">apcupsd</td>

70

81

71

82

<td>Sets up the connection to apcupsd daemon. Prints

72

83

nothing, defaults to localhost:3551

73

</td>

84

85

</td>

74

86

</tr>

75

87

76

88

<td align="center">apcupsd_cable</td>

77

89

78

90

<td>Prints the UPS connection type.

79

</td>

91

92

</td>

80

93

</tr>

81

94

82

95

<td align="center">apcupsd_charge</td>

83

96

84

97

<td>Current battery capacity in percent.

85

</td>

98

99

</td>

86

100

</tr>

87

101

88

102

<td align="center">apcupsd_lastxfer</td>

89

103

90

104

<td>Reason for last transfer from line to battery.

91

</td>

105

106

</td>

92

107

</tr>

93

108

94

109

<td align="center">apcupsd_linev</td>

95

110

96

111

<td>Nominal input voltage.

97

</td>

112

113

</td>

98

114

</tr>

99

115

100

116

<td align="center">apcupsd_load</td>

101

117

102

118

<td>Current load in percent.

103

</td>

119

120

</td>

104

121

</tr>

105

122

106

123

<td align="center">apcupsd_loadbar</td>

107

124

108

125

<td>Bar showing current load.

109

</td>

126

127

</td>

110

128

</tr>

111

129

112

130

<td align="center">apcupsd_loadgauge</td>

113

131

<td align="center">(height),(width)</td>

114

132

<td>Gauge that shows current load.

115

</td>

133

134

</td>

116

135

</tr>

117

136

118

137

<td align="center">apcupsd_loadgraph</td>

119

138

<td align="center">(height),(width) (gradient colour 1) (gradient

139

colour 2) (scale) (-t) (-l)</td>

120

140

<td>History graph of current load.

121

</td>

141

142

</td>

122

143

</tr>

123

144

124

145

<td align="center">apcupsd_model</td>

125

146

126

147

<td>Prints the model of the UPS.

127

</td>

148

149

</td>

128

150

</tr>

129

151

130

152

<td align="center">apcupsd_name</td>

131

153

132

154

<td>Prints the UPS user-defined name.

133

</td>

155

156

</td>

134

157

</tr>

135

158

136

159

<td align="center">apcupsd_status</td>

137

160

138

161

<td>Prints current status (on-line, on-battery).

139

</td>

162

163

</td>

140

164

</tr>

141

165

142

166

<td align="center">apcupsd_temp</td>

143

167

144

168

<td>Current internal temperature.

145

</td>

169

170

</td>

146

171

</tr>

147

172

148

173

<td align="center">apcupsd_timeleft</td>

149

174

150

175

<td>Time left to run on battery.

151

</td>

176

177

</td>

152

178

</tr>

153

179

154

180

<td align="center">apcupsd_upsmode</td>

155

181

156

182

<td>Prints the UPS mode (e.g. standalone).

157

</td>

183

184

</td>

158

185

</tr>

159

186

160

187

<td align="center">apm_adapter</td>

161

188

162

189

<td>Display APM AC adapter status (FreeBSD only)

163

</td>

190

191

</td>

164

192

</tr>

165

193

166

194

<td align="center">apm_battery_life</td>

167

195

168

196

<td>Display APM battery life in percent (FreeBSD

169

197

only)

170

</td>

198

199

</td>

171

200

</tr>

172

201

173

202

<td align="center">apm_battery_time</td>

175

204

<td>Display remaining APM battery life in hh:mm:ss or

176

205

"unknown" if AC adapterstatus is on-line or charging

177

206

(FreeBSD only)

178

</td>

207

208

</td>

179

209

</tr>

180

210

181

211

<td align="center">audacious_bar</td>

182

212

<td align="center">(height),(width)</td>

183

213

<td>Progress bar

184

</td>

214

215

</td>

185

216

</tr>

186

217

187

218

<td align="center">audacious_bitrate</td>

188

219

189

220

<td>Bitrate of current tune

190

</td>

221

222

</td>

191

223

</tr>

192

224

193

225

<td align="center">audacious_channels</td>

194

226

195

227

<td>Number of audio channels of current tune

196

</td>

228

229

</td>

197

230

</tr>

198

231

199

232

<td align="center">audacious_filename</td>

200

233

201

234

<td>Full path and filename of current tune

202

</td>

235

236

</td>

203

237

</tr>

204

238

205

239

<td align="center">audacious_frequency</td>

206

240

207

241

<td>Sampling frequency of current tune

208

</td>

242

243

</td>

209

244

</tr>

210

245

211

246

<td align="center">audacious_length</td>

212

247

213

248

<td>Total length of current tune as MM:SS

214

</td>

249

250

</td>

215

251

</tr>

216

252

217

253

<td align="center">audacious_length_seconds</td>

218

254

219

255

<td>Total length of current tune in seconds

220

</td>

256

257

</td>

221

258

</tr>

222

259

223

260

<td align="center">audacious_main_volume</td>

224

261

225

262

<td>The current volume fetched from Audacious

226

</td>

263

264

</td>

227

265

</tr>

228

266

229

267

<td align="center">audacious_playlist_length</td>

230

268

231

269

<td>Number of tunes in playlist

232

</td>

270

271

</td>

233

272

</tr>

234

273

235

274

<td align="center">audacious_playlist_position</td>

236

275

237

276

<td>Playlist position of current tune

238

</td>

277

278

</td>

239

279

</tr>

240

280

241

281

<td align="center">audacious_position</td>

242

282

243

283

<td>Position of current tune (MM:SS)

244

</td>

284

285

</td>

245

286

</tr>

246

287

247

288

<td align="center">audacious_position_seconds</td>

248

289

249

290

<td>Position of current tune in seconds

250

</td>

291

292

</td>

251

293

</tr>

252

294

253

295

<td align="center">audacious_status</td>

254

296

255

297

<td>Player status (Playing/Paused/Stopped/Not

256

298

running)

257

</td>

299

300

</td>

258

301

</tr>

259

302

260

303

<td align="center">audacious_title</td>

261

304

<td align="center">(max length)</td>

262

305

<td>Title of current tune with optional maximum

263

306

length specifier

264

</td>

307

308

</td>

265

309

</tr>

266

310

267

311

<td align="center">battery</td>

269

313

<td>Battery status and remaining percentage capacity

270

314

of ACPI or APM battery. ACPI battery number can be given as

271

315

argument (default is BAT0).

272

</td>

316

317

</td>

273

318

</tr>

274

319

275

320

<td align="center">battery_bar</td>

277

322

<td>Battery percentage remaining of ACPI battery in a

278

323

bar. ACPI battery number can be given as argument (default

279

324

is BAT0).

280

</td>

325

326

</td>

281

327

</tr>

282

328

283

329

<td align="center">battery_percent</td>

285

331

<td>Battery percentage remaining for ACPI battery.

286

332

ACPI battery number can be given as argument (default is

287

333

BAT0).

288

</td>

334

335

</td>

289

336

</tr>

290

337

291

338

<td align="center">battery_short</td>

293

340

<td>Battery status and remaining percentage capacity

294

341

of ACPI or APM battery. ACPI battery number can be given as

295

342

argument (default is BAT0). This mode display a short

296

status, which means that C is displayed instead of charging

297

and D is displayed instead of discharging.

298

</td>

343

status, which means that C is displayed instead of

344

charging, D for discharging, F for full, N for not present,

345

E for empty and U for unknown.

346

347

</td>

299

348

</tr>

300

349

301

350

<td align="center">battery_time</td>

303

352

<td>Battery charge/discharge time remaining of ACPI

304

353

battery. ACPI battery number can be given as argument

305

354

(default is BAT0).

306

</td>

355

356

</td>

307

357

</tr>

308

358

359

<td align="center">blink</td>

360

<td align="center">text_and_other_conky_vars</td>

361

<td>Let 'text_and_other_conky_vars' blink on and off.

362

363

364

</td>

365

</tr>

366

309

367

<td align="center">bmpx_album</td>

310

368

311

369

<td>Album in current BMPx track

312

</td>

370

371

</td>

313

372

</tr>

314

373

315

374

<td align="center">bmpx_artist</td>

316

375

317

376

<td>Artist in current BMPx track

318

</td>

377

378

</td>

319

379

</tr>

320

380

321

381

<td align="center">bmpx_bitrate</td>

322

382

323

383

<td>Bitrate of the current BMPx track

324

</td>

384

385

</td>

325

386

</tr>

326

387

327

388

<td align="center">bmpx_title</td>

328

389

329

390

<td>Title of the current BMPx track

330

</td>

391

392

</td>

331

393

</tr>

332

394

333

395

<td align="center">bmpx_track</td>

334

396

335

397

<td>Track number of the current BMPx track

336

</td>

398

399

</td>

337

400

</tr>

338

401

339

402

340

403

341

404

<td>URI of the current BMPx track

342

</td>

405

406

</td>

343

407

</tr>

344

408

345

409

<td align="center">buffers</td>

346

410

347

411

<td>Amount of memory buffered

348

</td>

412

413

</td>

349

414

</tr>

350

415

351

416

<td align="center">cached</td>

352

417

353

418

<td>Amount of memory cached

354

</td>

419

420

</td>

421

</tr>

422

423

<td align="center">cmdline_to_pid</td>

424

<td align="center">string</td>

425

<td>PID of the first process that has string in it's

426

commandline

427

428

</td>

355

429

</tr>

356

430

357

431

<td align="center">color</td>

358

432

<td align="center">(color)</td>

359

<td>Change drawing color to color

360

</td>

433

<td>Change drawing color to 'color' which is a name of

434

a color or a hexcode preceded with # (for example #0A1B2C ).

435

If you use ncurses only the following colors are supported:

436

red,green,yellow,blue,magenta,cyan,black,white.

437

438

</td>

361

439

</tr>

362

440

363

441

<td align="center">colorN</td>

364

442

365

443

<td>Change drawing color to colorN configuration

366

444

option, where N is a digit between 0 and 9, inclusively.

367

</td>

445

446

</td>

368

447

</tr>

369

448

370

449

<td align="center">combine</td>

371

450

372

451

<td>Places the lines of var2 to the right of the

373

lines of var1 seperated by the chars that are put between

452

lines of var1 separated by the chars that are put between

374

453

var1 and var2. For example: ${combine ${head /proc/cpuinfo

375

454

2} - ${head /proc/meminfo 1}} gives as output

376

455

"cpuinfo_line1 - meminfo_line1" on line 1 and

377

456

"cpuinfo_line2 -" on line 2. $combine vars can also be

378

457

nested to place more vars next to each other.

379

</td>

458

459

</td>

380

460

</tr>

381

461

382

462

<td align="center">conky_build_arch</td>

383

463

384

464

<td>CPU architecture Conky was built for

385

</td>

465

466

</td>

386

467

</tr>

387

468

388

469

<td align="center">conky_build_date</td>

389

470

390

471

<td>Date Conky was built

391

</td>

472

473

</td>

392

474

</tr>

393

475

394

476

<td align="center">conky_version</td>

395

477

396

478

<td>Conky version

397

</td>

479

480

</td>

398

481

</tr>

399

482

400

483

403

486

number can be provided as an argument. ${cpu cpu0} is the

404

487

total usage, and ${cpu cpuX} (X >= 1) are individual

405

488

CPUs.

406

</td>

489

490

</td>

407

491

</tr>

408

492

409

493

<td align="center">cpubar</td>

410

494

<td align="center">(cpuN) (height),(width)</td>

411

495

<td>Bar that shows CPU usage, height is bar's height

412

496

in pixels. See $cpu for more info on SMP.

413

</td>

497

498

</td>

414

499

</tr>

415

500

416

501

<td align="center">cpugauge</td>

418

503

<td>Elliptical gauge that shows CPU usage, height and

419

504

width are gauge's vertical and horizontal axis

420

505

respectively. See $cpu for more info on SMP.

421

</td>

506

507

</td>

422

508

</tr>

423

509

424

510

<td align="center">cpugraph</td>

425

<td align="center">(cpuN) ("normal"|"log") (height),(width)

426

(gradient colour 1) (gradient colour 2)

427

(scale)</td>

511

<td align="center">(cpuN) (height),(width) (gradient colour 1)

512

(gradient colour 2) (scale) (-t) (-l)</td>

428

513

<td>CPU usage graph, with optional colours in hex,

429

514

minus the #. See $cpu for more info on SMP. Uses a

430

logarithmic scale (to see small numbers) when you use "log"

431

instead of "normal".

515

logarithmic scale (to see small numbers) when you use the

516

-l switch. Takes the switch '-t' to use a temperature

517

gradient, which makes the gradient values change depending

518

on the amplitude of a particular graph value (try it and

519

see).

520

521

</td>

522

</tr>

523

524

525

<td align="center">url (interval_in_minutes)</td>

526

<td>

527

Download data from URI using Curl at the

528

specified interval. The interval may be a floating

529

point value greater than 0, otherwise defaults to 15

530

minutes. Most useful when used in conjunction with Lua

531

and the Lua API. This object is threaded, and once a

532

thread is created it can't be explicitly destroyed.

533

One thread will run for each URI specified. You can use

534

any protocol that Curl supports.

432

535

</td>

433

536

</tr>

537

538

<td align="center">desktop</td>

539

540

<td>Number of the desktop on which conky is running

541

or the message "Not running in X" if this is the case.

542

543

</td>

544

</tr>

545

546

<td align="center">desktop_name</td>

547

548

<td>Name of the desktop on which conky is running or

549

the message "Not running in X" if this is the case.

550

551

</td>

552

</tr>

553

554

<td align="center">desktop_number</td>

555

556

<td>Number of desktops or the message "Not running in

557

X" if this is the case.

558

559

</td>

560

</tr>

434

561

435

562

<td align="center">disk_protect</td>

436

563

<td align="center">device</td>

437

564

<td>Disk protection status, if supported (needs

438

565

kernel-patch). Prints either "frozen" or "free " (note the

439

566

padding).

440

</td>

567

568

</td>

441

569

</tr>

442

570

443

571

<td align="center">diskio</td>

445

573

<td>Displays current disk IO. Device is optional, and

446

574

takes the form of sda for /dev/sda. Individual partitions

447

575

are allowed.

448

</td>

576

577

</td>

449

578

</tr>

450

579

451

580

<td align="center">diskio_read</td>

452

581

<td align="center">(device)</td>

453

582

<td>Displays current disk IO for reads. Device as in

454

583

diskio.

455

</td>

584

585

</td>

456

586

</tr>

457

587

458

588

<td align="center">diskio_write</td>

459

589

<td align="center">(device)</td>

460

590

<td>Displays current disk IO for writes. Device as in

461

591

diskio.

462

</td>

592

593

</td>

463

594

</tr>

464

595

465

596

<td align="center">diskiograph</td>

466

<td align="center">(device) ("normal"|"log") (height),(width)

467

(gradient colour 1) (gradient colour 2)

468

(scale)</td>

597

<td align="center">(device) (height),(width) (gradient colour 1)

598

(gradient colour 2) (scale) (-t) (-l)</td>

469

599

<td>Disk IO graph, colours defined in hex, minus the

470

600

#. If scale is non-zero, it becomes the scale for the

471

601

graph. Uses a logarithmic scale (to see small numbers) when

472

you use "log" instead of "normal".

473

</td>

602

you use -l switch. Takes the switch '-t' to use a

603

temperature gradient, which makes the gradient values

604

change depending on the amplitude of a particular graph

605

value (try it and see).

606

607

</td>

474

608

</tr>

475

609

476

610

<td align="center">diskiograph_read</td>

477

<td align="center">(device) ("normal"|"log") (height),(width)

478

(gradient colour 1) (gradient colour 2)

479

(scale)</td>

611

<td align="center">(device) (height),(width) (gradient colour 1)

612

(gradient colour 2) (scale) (-t) (-l)</td>

480

613

<td>Disk IO graph for reads, colours defined in hex,

481

614

minus the #. If scale is non-zero, it becomes the scale for

482

615

the graph. Device as in diskio. Uses a logarithmic scale

483

(to see small numbers) when you use "log" instead of

484

"normal".

485

</td>

616

(to see small numbers) when you use -l switch. Takes the

617

switch '-t' to use a temperature gradient, which makes the

618

gradient values change depending on the amplitude of a

619

particular graph value (try it and see).

620

621

</td>

486

622

</tr>

487

623

488

624

<td align="center">diskiograph_write</td>

489

<td align="center">(device) ("normal"|"log") (height),(width)

490

(gradient colour 1) (gradient colour 2)

491

(scale)</td>

625

<td align="center">(device) (height),(width) (gradient colour 1)

626

(gradient colour 2) (scale) (-t) (-l)</td>

492

627

<td>Disk IO graph for writes, colours defined in hex,

493

628

minus the #. If scale is non-zero, it becomes the scale for

494

629

the graph. Device as in diskio. Uses a logarithmic scale

495

(to see small numbers) when you use "log" instead of

496

"normal".

497

</td>

630

(to see small numbers) when you use -l switch. Takes the

631

switch '-t' to use a temperature gradient, which makes the

632

gradient values change depending on the amplitude of a

633

particular graph value (try it and see).

634

635

</td>

498

636

</tr>

499

637

500

638

<td align="center">downspeed</td>

501

502

<td>Download speed in KiB

503

</td>

639

640

<td>Download speed in suitable IEC units

641

642

</td>

504

643

</tr>

505

644

506

645

<td align="center">downspeedf</td>

507

646

508

647

<td>Download speed in KiB with one decimal

509

</td>

648

649

</td>

510

650

</tr>

511

651

512

652

<td align="center">downspeedgraph</td>

513

<td align="center">(netdev) ("normal"|"log") (height),(width)

514

(gradient colour 1) (gradient colour 2)

515

(scale)</td>

653

<td align="center">(netdev) (height),(width) (gradient colour 1)

654

(gradient colour 2) (scale) (-t) (-l)</td>

516

655

<td>Download speed graph, colours defined in hex,

517

656

minus the #. If scale is non-zero, it becomes the scale for

518

657

the graph. Uses a logarithmic scale (to see small numbers)

519

when you use "log" instead of "normal".

520

</td>

658

when you use -l switch. Takes the switch '-t' to use a

659

temperature gradient, which makes the gradient values

660

change depending on the amplitude of a particular graph

661

value (try it and see).

662

663

</td>

521

664

</tr>

522

665

523

666

<td align="center">draft_mails</td>

525

668

<td>Number of mails marked as draft in the specified

526

669

mailbox or mail spool if not. Only maildir type mailboxes

527

670

are supported, mbox type will return -1.

528

</td>

671

672

</td>

529

673

</tr>

530

674

531

675

532

676

533

677

<td>Text to show if any of the above are not true

534

</td>

678

679

</td>

535

680

</tr>

536

681

537

682

<td align="center">endif</td>

538

683

539

684

<td>Ends an $if block.

540

</td>

685

686

</td>

541

687

</tr>

542

688

543

689

<td align="center">entropy_avail</td>

544

690

545

691

<td>Current entropy available for crypto freaks

546

</td>

692

693

</td>

547

694

</tr>

548

695

549

696

<td align="center">entropy_bar</td>

550

697

<td align="center">(height),(width)</td>

551

698

<td>Normalized bar of available entropy for crypto

552

699

freaks

553

</td>

700

701

</td>

554

702

</tr>

555

703

704

<td align="center">entropy_perc</td>

705

706

<td>Percentage of entropy available in comparison to

707

the poolsize

708

709

</td>

710

</tr>

711

556

712

<td align="center">entropy_poolsize</td>

557

713

558

714

<td>Total size of system entropy pool for crypto

559

715

freaks

560

</td>

716

717

</td>

561

718

</tr>

562

719

563

720

564

721

<td align="center">string</td>

565

<td>Evalutates given string according to the rules of

722

<td>Evaluates given string according to the rules of

566

723

TEXT interpretation, i.e. parsing any contained text object

567

724

specifications into their output, any occuring '$$' into a

568

725

single '$' and so on. The output is then being parsed

569

726

again.

570

</td>

727

728

</td>

571

729

</tr>

572

730

573

731

574

732

<td align="center">api_userid api_key character_id</td>

575

733

<td>Fetches your currently training skill from the

576

734

Eve Online API servers (http://www.eve-online.com/) and

577

735

displays the skill along with the remaining training time.

578

</td>

736

737

</td>

579

738

</tr>

580

739

581

740

582

741

<td align="center">command</td>

583

742

<td>Executes a shell command and displays the output

584

743

in conky. warning: this takes a lot more resources than

585

744

other variables. I'd recommend coding wanted behaviour in C

586

745

and posting a patch.

587

</td>

746

747

</td>

588

748

</tr>

589

749

590

750

<td align="center">execbar</td>

591

751

<td align="center">command</td>

592

752

<td>Same as exec, except if the first value return is

593

753

a value between 0-100, it will use that number for a bar.

594

754

The size for bars can be controlled via the

595

755

default_bar_size config setting.

596

</td>

756

757

</td>

597

758

</tr>

598

759

599

760

<td align="center">execgauge</td>

600

761

<td align="center">command</td>

601

762

<td>Same as exec, except if the first value returned

602

763

is a value between 0-100, it will use that number for a

603

764

gauge. The size for gauges can be controlled via the

604

765

default_gauge_size config setting.

605

</td>

766

767

</td>

606

768

</tr>

607

769

608

770

<td align="center">execgraph</td>

609

<td align="center">("normal"|"log") (height),(width) (gradient

610

colour 1) (gradient colour 2) (scale) command</td>

771

<td align="center">(-t) (-l) command</td>

611

772

<td>Same as execbar, but graphs values. Uses a

612

logaritmic scale when the log option is given (to see small

613

numbers). Values still have to be between 0 and 100. The

614

size for graphs can be controlled via the

615

default_graph_size config setting.

616

</td>

773

logaritmic scale when the log option (-l switch) is given

774

(to see small numbers). Values still have to be between 0

775

and 100. The size for graphs can be controlled via the

776

default_graph_size config setting. Takes the switch '-t' to

777

use a temperature gradient, which makes the gradient values

778

change depending on the amplitude of a particular graph

779

value (try it and see). If -t or -l is your first argument,

780

you may need to preceed it by a space (' ').

781

782

</td>

617

783

</tr>

618

784

619

785

<td align="center">execi</td>

620

786

<td align="center">interval command</td>

621

787

<td>Same as exec but with specific interval. Interval

622

788

can't be less than update_interval in configuration. See

623

789

also $texeci

624

</td>

790

791

</td>

625

792

</tr>

626

793

627

794

<td align="center">execibar</td>

628

795

<td align="center">interval command</td>

629

796

<td>Same as execbar, except with an interval

630

</td>

797

798

</td>

631

799

</tr>

632

800

633

801

<td align="center">execigauge</td>

634

802

<td align="center">interval command</td>

635

803

<td>Same as execgauge, but takes an interval arg and

636

804

gauges values.

637

</td>

805

806

</td>

638

807

</tr>

639

808

640

809

<td align="center">execigraph</td>

641

<td align="center">interval command</td>

810

<td align="center">interval (-t) (-l) command</td>

642

811

<td>Same as execgraph, but takes an interval arg and

643

graphs values.

644

</td>

812

graphs values. If -t or -l is your first argument, you may

813

need to preceed it by a space (' ').

814

815

</td>

645

816

</tr>

646

817

647

818

<td align="center">execp</td>

648

819

<td align="center">command</td>

649

820

<td>Executes a shell command and displays the output

659

830

functionally run at the same interval that the $execp

660

831

statement runs, as it is created and destroyed at every

661

832

interval.

662

</td>

833

834

</td>

663

835

</tr>

664

836

665

837

<td align="center">execpi</td>

666

838

<td align="center">interval command</td>

667

839

<td>Same as execp but with specific interval.

668

840

Interval can't be less than update_interval in

669

841

configuration. Note that the output from the $execpi

670

842

command is still parsed and evaluated at every interval.

671

</td>

843

844

</td>

672

845

</tr>

673

846

674

847

<td align="center">flagged_mails</td>

675

848

<td align="center">(maildir)</td>

676

849

<td>Number of mails marked as flagged in the

677

850

specified mailbox or mail spool if not. Only maildir type

678

851

mailboxes are supported, mbox type will return -1.

679

</td>

852

853

</td>

680

854

</tr>

681

855

682

856

683

857

684

858

<td>Specify a different font. This new font will

685

859

apply to the current line and everything following. You can

686

860

use a $font with no arguments to change back to the default

687

861

font (much like with $color)

688

</td>

862

863

</td>

864

</tr>

865

866

<td align="center">format_time</td>

867

<td align="center">seconds format</td>

868

<td>Format time given in seconds. This var only works when

869

the times_in_seconds configuration setting is on. Format is a string

870

that should start and end with a "-char. The "-chars are not

871

part of the output, \w,\d,\h,\m,\s,$,$ and \\ are replaced by

872

weeks,days,hours,minutes,seconds,(,) and \. If you leave out a unit,

873

it's value will be expressed in the highest unite lower then the

874

one left out. Text between ()-chars will not be visible if a

875

replaced unit in this text is 0. If seconds is a decimal number

876

then you can see the numbers behind the point by using \S

877

followed by a number that specifies the amount of

878

digits behind the point that you want to see (maximum 9).

879

You can also place a 'x' behind \S so you have all digits behind

880

the point and no trailing zero's. (also maximum 9)

881

882

</td>

689

883

</tr>

690

884

691

885

<td align="center">forwarded_mails</td>

693

887

<td>Number of mails marked as forwarded in the

694

888

specified mailbox or mail spool if not. Only maildir type

695

889

mailboxes are supported, mbox type will return -1.

696

</td>

890

891

</td>

697

892

</tr>

698

893

699

894

700

895

701

896

<td>Returns CPU #n's frequency in MHz. CPUs are

702

897

counted from 1. If omitted, the parameter defaults to 1.

703

</td>

898

899

</td>

704

900

</tr>

705

901

706

902

707

903

708

904

<td>Returns CPU #n's frequency in GHz. CPUs are

709

905

counted from 1. If omitted, the parameter defaults to 1.

710

</td>

906

907

</td>

711

908

</tr>

712

909

713

910

715

912

<td>Bar that shows how much space is used on a file

716

913

system. height is the height in pixels. fs is any file on

717

914

that file system.

718

</td>

915

916

</td>

719

917

</tr>

720

918

721

919

723

921

<td>Bar that shows how much space is free on a file

724

922

system. height is the height in pixels. fs is any file on

725

923

that file system.

726

</td>

924

925

</td>

727

926

</tr>

728

927

729

928

730

929

731

930

<td>Free space on a file system available for users.

732

</td>

931

932

</td>

733

933

</tr>

734

934

735

935

736

936

737

937

<td>Free percentage of space on a file system

738

938

available for users.

739

</td>

939

940

</td>

740

941

</tr>

741

942

742

943

743

944

744

945

<td>File system size.

745

</td>

946

947

</td>

746

948

</tr>

747

949

748

950

749

951

750

952

<td>File system type.

751

</td>

953

954

</td>

752

955

</tr>

753

956

754

957

755

958

756

959

<td>File system used space.

757

</td>

960

961

</td>

758

962

</tr>

759

963

760

964

761

965

762

966

<td>Percent of file system used space.

763

</td>

967

968

</td>

764

969

</tr>

765

970

766

971

767

972

768

973

<td>The next element will be printed at position 'x'.

769

974

770

</td>

975

976

</td>

771

977

</tr>

772

978

773

979

<td align="center">gw_iface</td>

774

980

775

981

<td>Displays the default route's interface or

776

982

"multiple"/"none" accordingly.

777

</td>

983

984

</td>

778

985

</tr>

779

986

780

987

781

988

782

989

<td>Displays the default gateway's IP or

783

990

"multiple"/"none" accordingly.

784

</td>

991

992

</td>

785

993

</tr>

786

994

787

995

<td align="center">hddtemp</td>

788

996

789

997

<td>Displays temperature of a selected hard disk

790

drive as reported by the hddtemp daemon running on

791

host:port. Default host is 127.0.0.1, default port is 7634.

792

793

</td>

998

drive as reported by the hddtemp daemon. Use hddtemp_host

999

and hddtemp_port to specify a host and port for all hddtemp

1000

objects. If no dev parameter is given, the first disk returned

1001

by the hddtemp daemon is used.

1002

1003

</td>

794

1004

</tr>

795

1005

796

1006

797

<td align="center">logfile lines (interval)</td>

798

<td>Displays first N lines of supplied text text

799

file. If interval is not supplied, Conky assumes 2x Conky's

800

interval. Max of 30 lines can be displayed, or until the

801

text buffer is filled.

802

</td>

1007

<td align="center">logfile lines (next_check)</td>

1008

<td>Displays first N lines of supplied text file. The

1009

file is checked every 'next_check' update. If next_check is

1010

not supplied, Conky defaults to 2. Max of 30 lines can be

1011

displayed, or until the text buffer is filled.

1012

1013

</td>

803

1014

</tr>

804

1015

805

1016

806

1017

<td align="center">(height)</td>

807

1018

<td>Horizontal line, height is the height in pixels

808

</td>

1019

1020

</td>

809

1021

</tr>

810

1022

811

1023

<td align="center">hwmon</td>

820

1032

being modified as follows: 'input = input * factor +

821

1033

offset'. Note that they have to be given as decimal values

822

1034

(i.e. contain at least one decimal place).

823

</td>

1035

1036

</td>

824

1037

</tr>

825

1038

826

1039

835

1048

modified as follows: 'input = input * factor + offset'.

836

1049

Note that they have to be given as decimal values (i.e.

837

1050

contain at least one decimal place).

838

</td>

1051

1052

</td>

839

1053

</tr>

840

1054

841

1055

<td align="center">i8k_ac_status</td>

844

1058

laptops, displays whether ac power is on, as listed in

845

1059

/proc/i8k (translated to human-readable). Beware that this

846

1060

is by default not enabled by i8k itself.

847

</td>

1061

1062

</td>

848

1063

</tr>

849

1064

850

1065

851

1066

852

1067

<td>If running the i8k kernel driver for Inspiron

853

1068

laptops, displays the bios version as listed in /proc/i8k.

854

</td>

1069

1070

</td>

855

1071

</tr>

856

1072

857

1073

<td align="center">i8k_buttons_status</td>

859

1075

<td>If running the i8k kernel driver for Inspiron

860

1076

laptops, displays the volume buttons status as listed in

861

1077

/proc/i8k.

862

</td>

1078

1079

</td>

863

1080

</tr>

864

1081

865

1082

867

1084

<td>If running the i8k kernel driver for Inspiron

868

1085

laptops, displays the cpu temperature in Celsius, as

869

1086

reported by /proc/i8k.

870

</td>

1087

1088

</td>

871

1089

</tr>

872

1090

873

1091

876

1094

laptops, displays the left fan's rate of rotation, in

877

1095

revolutions per minute as listed in /proc/i8k. Beware, some

878

1096

laptops i8k reports these fans in reverse order.

879

</td>

1097

1098

</td>

880

1099

</tr>

881

1100

882

1101

<td align="center">i8k_left_fan_status</td>

885

1104

laptops, displays the left fan status as listed in

886

1105

/proc/i8k (translated to human-readable). Beware, some

887

1106

laptops i8k reports these fans in reverse order.

888

</td>

1107

1108

</td>

889

1109

</tr>

890

1110

891

1111

<td align="center">i8k_right_fan_rpm</td>

894

1114

laptops, displays the right fan's rate of rotation, in

895

1115

revolutions per minute as listed in /proc/i8k. Beware, some

896

1116

laptops i8k reports these fans in reverse order.

897

</td>

1117

1118

</td>

898

1119

</tr>

899

1120

900

1121

<td align="center">i8k_right_fan_status</td>

903

1124

laptops, displays the right fan status as listed in

904

1125

/proc/i8k (translated to human-readable). Beware, some

905

1126

laptops i8k reports these fans in reverse order.

906

</td>

1127

1128

</td>

907

1129

</tr>

908

1130

909

1131

<td align="center">i8k_serial</td>

911

1133

<td>If running the i8k kernel driver for Inspiron

912

1134

laptops, displays your laptop serial number as listed in

913

1135

/proc/i8k.

914

</td>

1136

1137

</td>

915

1138

</tr>

916

1139

917

1140

<td align="center">i8k_version</td>

918

1141

919

1142

<td>If running the i8k kernel driver for Inspiron

920

1143

laptops, displays the version formatting of /proc/i8k.

921

</td>

1144

1145

</td>

922

1146

</tr>

923

1147

924

1148

<td align="center">ibm_brightness</td>

925

1149

926

1150

<td>If running the IBM ACPI, displays the brigtness

927

1151

of the laptops's LCD (0-7).

928

</td>

1152

1153

</td>

929

1154

</tr>

930

1155

931

1156

932

1157

933

1158

<td>If running the IBM ACPI, displays the fan speed.

934

</td>

1159

1160

</td>

935

1161

</tr>

936

1162

937

1163

<td align="center">ibm_temps</td>

939

1165

<td>If running the IBM ACPI, displays the

940

1166

temperatures from the IBM temperature sensors (N=0..7)

941

1167

Sensor 0 is on the CPU, 3 is on the GPU.

942

</td>

1168

1169

</td>

943

1170

</tr>

944

1171

945

1172

<td align="center">ibm_volume</td>

946

1173

947

1174

<td>If running the IBM ACPI, displays the "master"

948

1175

volume, controlled by the volume keys (0-14).

949

</td>

1176

1177

</td>

950

1178

</tr>

951

1179

952

1180

<td align="center">iconv_start</td>

953

1181

<td align="center">codeset_from codeset_to</td>

954

1182

<td>Convert text from one codeset to another using

955

1183

GNU iconv. Needs to be stopped with iconv_stop.

956

</td>

1184

1185

</td>

957

1186

</tr>

958

1187

959

1188

<td align="center">iconv_stop</td>

960

1189

961

1190

<td>Stop iconv codeset conversion.

962

</td>

1191

1192

</td>

963

1193

</tr>

964

1194

965

1195

<td align="center">if_empty</td>

966

1196

967

1197

<td>if conky variable VAR is empty, display

968

1198

everything between $if_empty and the matching $endif

969

</td>

1199

1200

</td>

970

1201

</tr>

971

1202

972

1203

<td align="center">if_existing</td>

976

1207

paramater checks for FILE containing the specified string

977

1208

and prints everything between $if_existing and the matching

978

1209

$endif.

979

</td>

1210

1211

</td>

980

1212

</tr>

981

1213

982

1214

983

1215

984

1216

<td>if there is at least one default gateway, display

985

1217

everything between $if_gw and the matching $endif

986

</td>

1218

1219

</td>

987

1220

</tr>

988

1221

989

1222

<td align="center">if_match</td>

995

1228

right side. Left and right sides are being parsed for

996

1229

contained text objects before evaluation. Recognised left

997

1230

and right side types are:

998

999

1000

double: argument consists of only

1001

digits and a single dot.

1002

1003

long: argument consists of only

1004

digits.

1005

1006

string: argument is enclosed in

1007

quotation mark or the checks for double and long failed

1008

before.

1009

Valid operands are: '>', '<', '>=',

1231

<ul>

1232

<li>

1233

double -

1234

Argument consists of only

1235

digits and a single dot.</li>

1236

<li>

1237

long -

1238

Argument consists of only

1239

digits.</li>

1240

<li>

1241

string -

1242

Argument is enclosed in

1243

quotation marks (")</li>

1244

</ul>Valid operands are: '>', '<', '>=',

1010

1245

'<=', '==', '!='.

1011

</td>

1246

1247

</td>

1012

1248

</tr>

1013

1249

1014

1250

<td align="center">if_mixer_mute</td>

1016

1252

<td>If mixer exists, display everything between

1017

1253

$if_mixer_mute and the matching $endif. If no mixer is

1018

1254

specified, "Master" is used.

1019

</td>

1255

1256

</td>

1020

1257

</tr>

1021

1258

1022

1259

<td align="center">if_mounted</td>

1023

1260

<td align="center">(mountpoint)</td>

1024

1261

<td>if MOUNTPOINT is mounted, display everything

1025

1262

between $if_mounted and the matching $endif

1026

</td>

1263

1264

</td>

1027

1265

</tr>

1028

1266

1029

1267

<td align="center">if_mpd_playing</td>

1030

1268

1031

1269

<td>if mpd is playing or paused, display everything

1032

1270

between $if_mpd_playing and the matching $endif

1033

</td>

1271

1272

</td>

1034

1273

</tr>

1035

1274

1036

1275

<td align="center">if_running</td>

1038

1277

<td>if PROCESS is running, display everything

1039

1278

$if_running and the matching $endif. This uses the

1040

1279

``pidof'' command, so the -x switch is also supported.

1041

</td>

1280

1281

</td>

1042

1282

</tr>

1043

1283

1044

1284

<td align="center">if_smapi_bat_installed</td>

1046

1286

<td>when using smapi, if the battery with index INDEX

1047

1287

is installed, display everything between

1048

1288

$if_smapi_bat_installed and the matching $endif

1049

</td>

1289

1290

</td>

1050

1291

</tr>

1051

1292

1052

1293

1053

1294

<td align="center">(interface)</td>

1054

1295

<td>if INTERFACE exists and is up, display everything

1055

1296

between $if_up and the matching $endif

1056

</td>

1297

1298

</td>

1057

1299

</tr>

1058

1300

1059

1301

<td align="center">if_updatenr</td>

1065

1307

2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the

1066

1308

time followed by bar 25% of the time followed by nothing

1067

1309

the other half of the time.

1068

</td>

1310

1311

</td>

1069

1312

</tr>

1070

1313

1071

1314

<td align="center">if_xmms2_connected</td>

1072

1315

1073

1316

<td>Display everything between $if_xmms2_connected

1074

1317

and the matching $endif if xmms2 is running.

1075

</td>

1318

1319

</td>

1076

1320

</tr>

1077

1321

1078

1322

<td align="center">image</td>

1079

<td align="center"><path to image> (-p x,y) (-s

1080

WxH)</td>

1323

<td align="center"><path to image> (-p x,y) (-s WxH) (-n)

1324

(-f interval)</td>

1081

1325

<td>Renders an image from the path specified using

1082

IMLIB2. Takes 2 optional arguments, one being a position,

1083

the other an size. Changing the x,y position will move the

1084

position of the image, and changing the WxH will scale the

1085

image. Example: ${image /home/brenden/cheeseburger.jpg -p

1086

20,20 -s 200x200} will render 'cheeseburger.jpg' at (20,20)

1087

scaled to 200x200 pixels. Conky does not make any attempt

1088

to adjust the position (or any other formatting) of images,

1089

they are just rendered as per the arguments passed. The

1090

only reason $image is part of the TEXT section, is to allow

1091

for runtime modifications, through $execp $lua_parse,

1092

$lua_read_parse, or some other method.

1093

</td>

1326

Imlib2. Takes 4 optional arguments: a position, a size, a

1327

no-cache switch, and a cache flush interval. Changing the

1328

x,y position will move the position of the image, and

1329

changing the WxH will scale the image. If you specify the

1330

no-cache flag (-n), the image will not be cached.

1331

Alternately, you can specify the -f int switch to specify a

1332

cache flust interval for a particular image. Example:

1333

${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}

1334

will render 'cheeseburger.jpg' at (20,20) scaled to 200x200

1335

pixels. Conky does not make any attempt to adjust the

1336

position (or any other formatting) of images, they are just

1337

rendered as per the arguments passed. The only reason

1338

$image is part of the TEXT section, is to allow for runtime

1339

modifications, through $execp $lua_parse, or some other

1340

method.

1341

1342

</td>

1094

1343

</tr>

1095

1344

1096

1345

<td align="center">imap_messages</td>

1097

1346

1098

1347

<td>Displays the number of messages in your global

1099

1348

IMAP inbox by default. You can define individual IMAP

1100

inboxes seperately by passing arguments to this object.

1349

inboxes separately by passing arguments to this object.

1101

1350

Arguments are: "host user pass [-i interval (in seconds)]

1102

[-f folder] [-p port] [-e command] [-r retries]". Default

1351

[-f 'folder'] [-p port] [-e 'command'] [-r retries]". Default

1103

1352

port is 143, default folder is 'INBOX', default interval is

1104

1353

5 minutes, and default number of retries before giving up

1105

1354

is 5. If the password is supplied as '*', you will be

1106

1355

prompted to enter the password when Conky starts.

1107

</td>

1356

1357

</td>

1108

1358

</tr>

1109

1359

1110

1360

<td align="center">imap_unseen</td>

1111

1361

1112

1362

<td>Displays the number of unseen messages in your

1113

1363

global IMAP inbox by default. You can define individual

1114

IMAP inboxes seperately by passing arguments to this

1364

IMAP inboxes separately by passing arguments to this

1115

1365

object. Arguments are: "host user pass [-i interval (in

1116

seconds)] [-f folder] [-p port] [-e command] [-r retries]".

1366

seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r retries]".

1117

1367

Default port is 143, default folder is 'INBOX', default

1118

1368

interval is 5 minutes, and default number of retries before

1119

1369

giving up is 5. If the password is supplied as '*', you

1120

1370

will be prompted to enter the password when Conky starts.

1371

1372

</td>

1373

</tr>

1374

1375

<td align="center">include</td>

1376

1377

<td>

1378

Loads the configfile at path, places the

1379

configsettings behind the configsettings in the orginal

1380

config and places the vars where the includevar

1381

stood.

1121

1382

</td>

1122

1383

</tr>

1123

1384

1124

1385

<td align="center">ioscheduler</td>

1125

1386

1126

1387

<td>Prints the current ioscheduler used for the given

1127

1388

disk name (i.e. e.g. "hda" or "sdb")

1128

</td>

1389

1390

</td>

1129

1391

</tr>

1130

1392

1131

1393

<td align="center">kernel</td>

1132

1394

1133

1395

<td>Kernel version

1134

</td>

1396

1397

</td>

1135

1398

</tr>

1136

1399

1137

1400

<td align="center">laptop_mode</td>

1138

1401

1139

1402

<td>The value of /proc/sys/vm/laptop_mode

1140

</td>

1403

1404

</td>

1141

1405

</tr>

1142

1406

1143

1407

<td align="center">lines</td>

1144

1408

<td align="center">textfile</td>

1145

1409

<td>Displays the number of lines in the given file

1146

</td>

1410

1411

</td>

1147

1412

</tr>

1148

1413

1149

1414

<td align="center">loadavg</td>

1150

1151

<td>(1,2,3)> System load average, 1 is for past 1

1152

minute, 2 for past 5 minutes and 3 for past 15 minutes.

1153

</td>

1415

1416

<td>System load average, 1 is for past 1 minute, 2

1417

for past 5 minutes and 3 for past 15 minutes. Without argument, prints

1418

all three values separated by whitespace.

1419

1420

</td>

1154

1421

</tr>

1155

1422

1156

1423

<td align="center">loadgraph</td>

1157

<td align="center">("normal"|"log") (height),(width) (gradient

1158

colour 1) (gradient colour 2) (scale)</td>

1424

<td align="center">(height),(width) (gradient colour 1)

1425

(gradient colour 2) (scale) (-t) (-l)</td>

1159

1426

<td>Load1 average graph, similar to xload, with

1160

1427

optional colours in hex, minus the #. Uses a logarithmic

1161

scale (to see small numbers) when you use "log" instead of

1162

"normal".

1163

</td>

1428

scale (to see small numbers) when you use the -l switch.

1429

Takes the switch '-t' to use a temperature gradient, which

1430

makes the gradient values change depending on the amplitude

1431

of a particular graph value (try it and see).

1432

1433

</td>

1164

1434

</tr>

1165

1435

1166

1436

1167

1437

<td align="center">function_name (function parameters)</td>

1168

1438

<td>Executes a Lua function with given parameters,

1169

1439

then prints the returned string. See also 'lua_load' on how

1170

to load scripts.

1171

</td>

1440

to load scripts. Conky puts 'conky_' in front of

1441

function_name to prevent accidental calls to the wrong

1442

function unless you put you place 'conky_' in front of it

1443

yourself.

1444

1445

</td>

1172

1446

</tr>

1173

1447

1174

1448

1175

1449

<td align="center">(height, width) function_name (function

1176

1450

parameters)</td>

1177

1451

<td>Executes a Lua function with given parameters and

1178

1452

draws a bar. Expects result value to be an integer between

1179

0 and 100. See also 'lua_load' on how to load scripts.

1180

</td>

1453

0 and 100. See also 'lua_load' on how to load scripts.

1454

Conky puts 'conky_' in front of function_name to prevent

1455

accidental calls to the wrong function unless you put you

1456

place 'conky_' in front of it yourself.

1457

1458

</td>

1181

1459

</tr>

1182

1460

1183

1461

<td align="center">lua_gauge</td>

1184

1462

<td align="center">(height, width) function_name (function

1185

1463

parameters)</td>

1186

1464

<td>Executes a Lua function with given parameters and

1187

1465

draws a gauge. Expects result value to be an integer

1188

1466

between 0 and 100. See also 'lua_load' on how to load

1189

scripts.

1190

</td>

1467

scripts. Conky puts 'conky_' in front of function_name to

1468

prevent accidental calls to the wrong function unless you

1469

put you place 'conky_' in front of it yourself.

1470

1471

</td>

1191

1472

</tr>

1192

1473

1193

1474

<td align="center">lua_graph</td>

1194

<td align="center">function_name (function parameters)

1195

("normal"|"log") (height),(width) (gradient colour 1)

1196

(gradient colour 2) (scale)</td>

1197

<td>Executes a Lua function with given parameters and

1198

draws a graph. Expects result value to be any number, and

1199

by default will scale to show the full range. See also

1200

'lua_load' on how to load scripts.

1201

</td>

1475

<td align="center">function_name (height),(width) (gradient colour

1476

1) (gradient colour 2) (scale) (-t) (-l)</td>

1477

<td>Executes a Lua function with and draws a graph.

1478

Expects result value to be any number, and by default will

1479

scale to show the full range. See also 'lua_load' on how to

1480

load scripts. Takes the switch '-t' to use a temperature

1481

gradient, which makes the gradient values change depending

1482

on the amplitude of a particular graph value (try it and

1483

see). Conky puts 'conky_' in front of function_name to

1484

prevent accidental calls to the wrong function unless you

1485

put you place 'conky_' in front of it yourself.

1486

1487

</td>

1202

1488

</tr>

1203

1489

1204

1490

<td align="center">lua_parse</td>

1205

1491

<td align="center">function_name (function parameters)</td>

1206

1492

<td>Executes a Lua function with given parameters as

1207

1493

per $lua, then parses and prints the result value as per

1208

1494

the syntax for Conky's TEXT section. See also 'lua_load' on

1209

how to load scripts.

1210

</td>

1211

</tr>

1212

1213

<td align="center">lua_read_parse</td>

1214

<td align="center">function_name (conky text)</td>

1215

<td>Executes a Lua function per $lua, except takes a

1216

2nd argument which is first evaluated as per Conky's TEXT

1217

section and passed to the function first. The return value

1218

is then parsed and prints the result value as per the

1219

syntax for Conky's TEXT section. See also 'lua_load' on how

1220

to load scripts.

1221

</td>

1495

how to load scripts. Conky puts 'conky_' in front of

1496

function_name to prevent accidental calls to the wrong

1497

function unless you put you place 'conky_' in front of it

1498

yourself.

1499

1500

</td>

1222

1501

</tr>

1223

1502

1224

1503

<td align="center">machine</td>

1225

1504

1226

1505

<td>Machine, i686 for example

1227

</td>

1506

1507

</td>

1228

1508

</tr>

1229

1509

1230

1510

<td align="center">mails</td>

1234

1514

supported. You can use a program like fetchmail to get

1235

1515

mails from some server using your favourite protocol. See

1236

1516

also new_mails.

1237

</td>

1517

1518

</td>

1238

1519

</tr>

1239

1520

1240

1521

<td align="center">mboxscan</td>

1244

1525

format mailbox. mbox parameter is the filename of the

1245

1526

mailbox (can be encapsulated using '"', ie. ${mboxscan -n

1246

1527

10 "/home/brenden/some box"}

1247

</td>

1528

1529

</td>

1248

1530

</tr>

1249

1531

1250

1532

1251

1533

1252

1534

<td>Amount of memory in use

1253

</td>

1535

1536

</td>

1254

1537

</tr>

1255

1538

1256

1539

<td align="center">membar</td>

1257

1540

<td align="center">(height),(width)</td>

1258

1541

<td>Bar that shows amount of memory in use

1259

</td>

1542

1543

</td>

1260

1544

</tr>

1261

1545

1262

1546

<td align="center">memeasyfree</td>

1263

1547

1264

1548

<td>Amount of free memory including the memory that

1265

1549

is very easily freed (buffers/cache)

1266

</td>

1550

1551

</td>

1267

1552

</tr>

1268

1553

1269

1554

<td align="center">memfree</td>

1270

1555

1271

1556

<td>Amount of free memory

1272

</td>

1557

1558

</td>

1273

1559

</tr>

1274

1560

1275

1561

<td align="center">memgauge</td>

1276

1562

<td align="center">(height),(width)</td>

1277

1563

<td>Gauge that shows amount of memory in use (see

1278

1564

cpugauge)

1279

</td>

1565

1566

</td>

1280

1567

</tr>

1281

1568

1282

1569

<td align="center">memgraph</td>

1283

<td align="center">("normal"|"log") (height),(width) (gradient

1284

colour 1) (gradient colour 2) (scale)</td>

1570

<td align="center">(height),(width) (gradient colour 1) (gradient

1571

colour 2) (scale) (-t) (-l)</td>

1285

1572

<td>Memory usage graph. Uses a logarithmic scale (to

1286

see small numbers) when you use "log" instead of "normal".

1287

</td>

1573

see small numbers) when you use the -l switch. Takes the

1574

switch '-t' to use a temperature gradient, which makes the

1575

gradient values change depending on the amplitude of a

1576

particular graph value (try it and see).

1577

1578

</td>

1288

1579

</tr>

1289

1580

1290

1581

<td align="center">memmax</td>

1291

1582

1292

1583

<td>Total amount of memory

1293

</td>

1584

1585

</td>

1294

1586

</tr>

1295

1587

1296

1588

<td align="center">memperc</td>

1297

1589

1298

1590

<td>Percentage of memory in use

1299

</td>

1591

1592

</td>

1300

1593

</tr>

1301

1594

1302

1595

<td align="center">mixer</td>

1303

1596

<td align="center">(device)</td>

1304

1597

<td>Prints the mixer value as reported by the OS.

1305

Default mixer is "vol", but you can specify one of the

1306

following optional arguments: "vol", "bass", "treble",

1307

"synth", "pcm", "speaker", "line", "mic", "cd", "mix",

1308

"pcm2", "rec", "igain", "ogain", "line1", "line2", "line3",

1309

"dig1", "dig2", "dig3", "phin", "phout", "video", "radio",

1310

"monitor". Refer to the definition of SOUND_DEVICE_NAMES in

1311

<linux/soundcard.h> (on Linux), <soundcard.h>

1312

(on OpenBSD), or <sys/soundcard.h> to find the exact

1313

options available on your system.

1314

</td>

1598

Default mixer is "Master", but you can specify one of the

1599

available ALSA Simple mixer controls.

1600

You can find the list of those available on your system

1601

using amixer.

1602

1603

</td>

1315

1604

</tr>

1316

1605

1317

1606

<td align="center">mixerbar</td>

1318

1607

<td align="center">(device)</td>

1319

1608

<td>Displays mixer value in a bar as reported by the

1320

1609

OS. See docs for $mixer for details on arguments.

1321

</td>

1610

1611

</td>

1322

1612

</tr>

1323

1613

1324

1614

<td align="center">mixerl</td>

1325

1615

<td align="center">(device)</td>

1326

1616

<td>Prints the left channel mixer value as reported

1327

1617

by the OS. See docs for $mixer for details on arguments.

1328

</td>

1618

1619

</td>

1329

1620

</tr>

1330

1621

1331

1622

<td align="center">mixerlbar</td>

1333

1624

<td>Displays the left channel mixer value in a bar as

1334

1625

reported by the OS. See docs for $mixer for details on

1335

1626

arguments.

1336

</td>

1627

1628

</td>

1337

1629

</tr>

1338

1630

1339

1631

<td align="center">mixerr</td>

1340

1632

<td align="center">(device)</td>

1341

1633

<td>Prints the right channel mixer value as reported

1342

1634

by the OS. See docs for $mixer for details on arguments.

1343

</td>

1635

1636

</td>

1344

1637

</tr>

1345

1638

1346

1639

<td align="center">mixerrbar</td>

1348

1641

<td>Displays the right channel mixer value in a bar

1349

1642

as reported by the OS. See docs for $mixer for details on

1350

1643

arguments.

1351

</td>

1644

1645

</td>

1352

1646

</tr>

1353

1647

1354

1648

<td align="center">moc_album</td>

1355

1649

1356

1650

<td>Album of the current MOC song

1357

</td>

1651

1652

</td>

1358

1653

</tr>

1359

1654

1360

1655

<td align="center">moc_artist</td>

1361

1656

1362

1657

<td>Artist of the current MOC song

1363

</td>

1658

1659

</td>

1364

1660

</tr>

1365

1661

1366

1662

<td align="center">moc_bitrate</td>

1367

1663

1368

1664

<td>Bitrate in the current MOC song

1369

</td>

1665

1666

</td>

1370

1667

</tr>

1371

1668

1372

1669

<td align="center">moc_curtime</td>

1373

1670

1374

1671

<td>Current time of the current MOC song

1375

</td>

1672

1673

</td>

1376

1674

</tr>

1377

1675

1378

1676

1379

1677

1380

1678

<td>File name of the current MOC song

1381

</td>

1679

1680

</td>

1382

1681

</tr>

1383

1682

1384

1683

1385

1684

1386

1685

<td>Rate of the current MOC song

1387

</td>

1686

1687

</td>

1388

1688

</tr>

1389

1689

1390

1690

1391

1691

1392

1692

<td>The current song name being played in MOC.

1393

</td>

1693

1694

</td>

1394

1695

</tr>

1395

1696

1396

1697

<td align="center">moc_state</td>

1397

1698

1398

1699

<td>Current state of MOC; playing, stopped etc.

1399

</td>

1700

1701

</td>

1400

1702

</tr>

1401

1703

1402

1704

<td align="center">moc_timeleft</td>

1403

1705

1404

1706

<td>Time left in the current MOC song

1405

</td>

1707

1708

</td>

1406

1709

</tr>

1407

1710

1408

1711

<td align="center">moc_title</td>

1409

1712

1410

1713

<td>Title of the current MOC song

1411

</td>

1714

1715

</td>

1412

1716

</tr>

1413

1717

1414

1718

<td align="center">moc_totaltime</td>

1415

1719

1416

1720

<td>Total length of the current MOC song

1417

</td>

1721

1722

</td>

1418

1723

</tr>

1419

1724

1420

1725

<td align="center">monitor</td>

1421

1726

1422

<td>Number of the monitor on which conky is running

1423

</td>

1727

<td>Number of the monitor on which conky is running

1728

or the message "Not running in X" if this is the case.

1729

1730

</td>

1424

1731

</tr>

1425

1732

1426

1733

<td align="center">monitor_number</td>

1427

1734

1428

<td>Number of monitors

1429

</td>

1735

<td>Number of monitors or the message "Not running in

1736

X" if this is the case.

1737

1738

</td>

1430

1739

</tr>

1431

1740

1432

1741

<td align="center">mpd_album</td>

1433

1742

1434

1743

<td>Album in current MPD song

1435

</td>

1744

1745

</td>

1436

1746

</tr>

1437

1747

1438

1748

<td align="center">mpd_artist</td>

1439

1749

1440

1750

<td>Artist in current MPD song must be enabled at

1441

1751

compile

1442

</td>

1752

1753

</td>

1443

1754

</tr>

1444

1755

1445

1756

1446

1757

<td align="center">(height),(width)</td>

1447

1758

<td>Bar of mpd's progress

1448

</td>

1759

1760

</td>

1449

1761

</tr>

1450

1762

1451

1763

<td align="center">mpd_bitrate</td>

1452

1764

1453

1765

<td>Bitrate of current song

1454

</td>

1766

1767

</td>

1455

1768

</tr>

1456

1769

1457

1770

<td align="center">mpd_elapsed</td>

1458

1771

1459

1772

<td>Song's elapsed time

1460

</td>

1773

1774

</td>

1461

1775

</tr>

1462

1776

1463

1777

1464

1778

1465

1779

<td>Prints the file name of the current MPD song

1466

</td>

1780

1781

</td>

1467

1782

</tr>

1468

1783

1469

1784

<td align="center">mpd_length</td>

1470

1785

1471

1786

<td>Song's length

1472

</td>

1787

1788

</td>

1473

1789

</tr>

1474

1790

1475

1791

1476

1792

1477

1793

<td>Prints the MPD name field

1478

</td>

1794

1795

</td>

1479

1796

</tr>

1480

1797

1481

1798

<td align="center">mpd_percent</td>

1482

1799

1483

1800

<td>Percent of song's progress

1484

</td>

1801

1802

</td>

1485

1803

</tr>

1486

1804

1487

1805

<td align="center">mpd_random</td>

1488

1806

1489

1807

<td>Random status (On/Off)

1490

</td>

1808

1809

</td>

1491

1810

</tr>

1492

1811

1493

1812

<td align="center">mpd_repeat</td>

1494

1813

1495

1814

<td>Repeat status (On/Off)

1496

</td>

1815

1816

</td>

1497

1817

</tr>

1498

1818

1499

1819

<td align="center">mpd_smart</td>

1500

1820

<td align="center">(max length)</td>

1501

1821

<td>Prints the song name in either the form "artist -

1502

1822

title" or file name, depending on whats available

1503

</td>

1823

1824

</td>

1504

1825

</tr>

1505

1826

1506

1827

<td align="center">mpd_status</td>

1507

1828

1508

1829

<td>Playing, stopped, et cetera.

1509

</td>

1830

1831

</td>

1510

1832

</tr>

1511

1833

1512

1834

<td align="center">mpd_title</td>

1513

1835

<td align="center">(max length)</td>

1514

1836

<td>Title of current MPD song

1515

</td>

1837

1838

</td>

1516

1839

</tr>

1517

1840

1518

1841

<td align="center">mpd_track</td>

1519

1842

1520

1843

<td>Prints the MPD track field

1521

</td>

1844

1845

</td>

1522

1846

</tr>

1523

1847

1524

1848

1525

1849

1526

1850

<td>MPD's volume

1527

</td>

1851

1852

</td>

1528

1853

</tr>

1529

1854

1530

1855

<td align="center">nameserver</td>

1531

1856

<td align="center">(index)</td>

1532

1857

<td>Print a nameserver from /etc/resolv.conf. Index

1533

1858

starts at and defaults to 0.

1534

</td>

1859

1860

</td>

1535

1861

</tr>

1536

1862

1537

1863

<td align="center">new_mails</td>

1539

1865

<td>Unread mail count in the specified mailbox or

1540

1866

mail spool if not. Both mbox and maildir type mailboxes are

1541

1867

supported.

1542

</td>

1868

1869

</td>

1543

1870

</tr>

1544

1871

1545

1872

<td align="center">nodename</td>

1546

1873

1547

1874

<td>Hostname

1548

</td>

1875

1876

</td>

1549

1877

</tr>

1550

1878

1551

1879

<td align="center">nvidia</td>

1554

1882

library. Each option can be shortened to the least

1555

1883

significant part. Temperatures are printed as float, all

1556

1884

other values as integer.

1557

1558

1559

threshold: the thresholdtemperature

1560

at which the gpu slows down

1561

1562

temp: gives the gpu current

1563

temperature

1564

1565

ambient: gives current air

1566

temperature near GPU case

1567

1568

gpufreq: gives the current gpu

1569

frequency

1570

1571

memfreq: gives the current mem

1572

frequency

1573

1574

imagequality: which imagequality

1575

should be choosen by OpenGL applications

1576

1577

</td>

1885

<ul>

1886

<li>

1887

threshold -

1888

1889

The thresholdtemperature at

1890

which the gpu slows down

1891

</li>

1892

<li>

1893

temp -

1894

1895

Gives the gpu current

1896

temperature

1897

</li>

1898

<li>

1899

ambient -

1900

1901

Gives current air temperature near GPU

1902

case

1903

</li>

1904

<li>

1905

gpufreq -

1906

1907

Gives the current gpu frequency

1908

</li>

1909

<li>

1910

memfreq -

1911

1912

Gives the current mem frequency

1913

</li>

1914

<li>

1915

imagequality -

1916

1917

Which imagequality should be chosen by

1918

OpenGL applications

1919

</li>

1920

</ul>

1921

1922

</td>

1578

1923

</tr>

1579

1924

1580

1925

<td align="center">offset</td>

1581

1926

<td align="center">(pixels)</td>

1582

1927

<td>Move text over by N pixels. See also $voffset.

1583

</td>

1928

1929

</td>

1584

1930

</tr>

1585

1931

1586

1932

<td align="center">outlinecolor</td>

1587

1933

<td align="center">(color)</td>

1588

1934

<td>Change outline color

1589

</td>

1935

1936

</td>

1590

1937

</tr>

1591

1938

1592

1939

<td align="center">pb_battery</td>

1595

1942

information on battery status. The item parameter

1596

1943

specifies, what information to display. Exactly one item

1597

1944

must be specified. Valid items are:

1598

1599

1600

status: Display if battery is fully

1601

charged, charging, discharging or absent (running on

1602

AC)

1603

1604

percent: Display charge of battery

1605

in percent, if charging or discharging. Nothing will be

1606

displayed, if battery is fully charged or

1607

absent.

1608

1609

time: Display the time remaining

1610

until the battery will be fully charged or discharged

1611

at current rate. Nothing is displayed, if battery is

1612

absent or if it's present but fully charged and not

1613

discharging.

1614

1615

</td>

1945

<ul>

1946

<li>

1947

status -

1948

1949

Display if battery is fully charged,

1950

charging, discharging or absent (running on

1951

AC)

1952

</li>

1953

<li>

1954

percent -

1955

1956

Display charge of battery in percent, if

1957

charging or discharging. Nothing will be displayed,

1958

if battery is fully charged or absent.

1959

</li>

1960

<li>

1961

time -

1962

1963

Display the time remaining until the

1964

battery will be fully charged or discharged at

1965

current rate. Nothing is displayed, if battery is

1966

absent or if it's present but fully charged and not

1967

discharging.

1968

</li>

1969

</ul>

1970

1971

</td>

1972

</tr>

1973

1974

<td align="center">pid_chroot</td>

1975

1976

<td>Directory used as rootdirectory by the process

1977

(this will be "/" unless the process did a chroot syscall)

1978

1979

</td>

1980

</tr>

1981

1982

<td align="center">pid_cmdline</td>

1983

1984

<td>Command line this process was invoked with

1985

1986

</td>

1987

</tr>

1988

1989

1990

1991

<td>Current working directory of the process

1992

1993

</td>

1994

</tr>

1995

1996

<td align="center">pid_environ</td>

1997

<td align="center">pid varname</td>

1998

<td>Contents of a environment-var of the process

1999

2000

</td>

2001

</tr>

2002

2003

<td align="center">pid_environ_list</td>

2004

2005

<td>List of environment-vars that the process can see

2006

2007

</td>

2008

</tr>

2009

2010

2011

2012

<td>Path to executed command that started the process

2013

2014

</td>

2015

</tr>

2016

2017

2018

2019

<td>The nice value of the process

2020

2021

</td>

2022

</tr>

2023

2024

<td align="center">pid_openfiles</td>

2025

2026

<td>List of files that the process has open

2027

2028

</td>

2029

</tr>

2030

2031

<td align="center">pid_parent</td>

2032

2033

<td>The pid of the parent of the process

2034

2035

</td>

2036

</tr>

2037

2038

<td align="center">pid_priority</td>

2039

2040

<td>The priority of the process (see 'priority' in "man 5 proc")

2041

2042

</td>

2043

</tr>

2044

2045

2046

2047

<td>Total number of bytes read by the process

2048

2049

</td>

2050

</tr>

2051

2052

<td align="center">pid_state</td>

2053

2054

<td>State of the process

2055

2056

</td>

2057

</tr>

2058

2059

<td align="center">pid_state_short</td>

2060

2061

<td>One of the chars in "RSDZTW" representing the state

2062

of the process where R is running, S is sleeping in an

2063

interruptible wait, D is waiting in uninterruptible disk sleep,

2064

Z is zombie, T is traced or stopped (on a signal), and W is paging

2065

2066

</td>

2067

</tr>

2068

2069

<td align="center">pid_stderr</td>

2070

2071

<td>Filedescriptor binded to the STDERR of the process

2072

2073

</td>

2074

</tr>

2075

2076

<td align="center">pid_stdin</td>

2077

2078

<td>Filedescriptor binded to the STDIN of the process

2079

2080

</td>

2081

</tr>

2082

2083

<td align="center">pid_stdout</td>

2084

2085

<td>Filedescriptor binded to the STDOUT of the process

2086

2087

</td>

2088

</tr>

2089

2090

<td align="center">pid_threads</td>

2091

2092

<td>Number of threads in process containing this thread

2093

2094

</td>

2095

</tr>

2096

2097

<td align="center">pid_thread_list</td>

2098

2099

<td>List with pid's from threads from this process

2100

2101

</td>

2102

</tr>

2103

2104

<td align="center">pid_time_kernelmode</td>

2105

2106

<td>Amount of time that the process has been scheduled in kernel mode in seconds

2107

2108

</td>

2109

</tr>

2110

2111

<td align="center">pid_time_usermode</td>

2112

2113

<td>Amount of time that the process has been scheduled in user mode in seconds

2114

2115

</td>

2116

</tr>

2117

2118

2119

2120

<td>Sum of $pid_time_kernelmode and $pid_time_usermode

2121

2122

</td>

2123

</tr>

2124

2125

2126

2127

<td>The real uid of the process

2128

2129

</td>

2130

</tr>

2131

2132

2133

2134

<td>The effective uid of the process

2135

2136

</td>

2137

</tr>

2138

2139

2140

2141

<td>The saved set uid of the process

2142

2143

</td>

2144

</tr>

2145

2146

<td align="center">pid_fsuid</td>

2147

2148

<td>The file system uid of the process

2149

2150

</td>

2151

</tr>

2152

2153

2154

2155

<td>The real gid of the process

2156

2157

</td>

2158

</tr>

2159

2160

2161

2162

<td>The effective gid of the process

2163

2164

</td>

2165

</tr>

2166

2167

2168

2169

<td>The saved set gid of the process

2170

2171

</td>

2172

</tr>

2173

2174

<td align="center">pid_fsgid</td>

2175

2176

<td>The file system gid of the process

2177

2178

</td>

2179

</tr>

2180

2181

<td align="center">pid_vmpeak</td>

2182

2183

<td>Peak virtual memory size of the process

2184

2185

</td>

2186

</tr>

2187

2188

<td align="center">pid_vmsize</td>

2189

2190

<td>Virtual memory size of the process

2191

2192

</td>

2193

</tr>

2194

2195

<td align="center">pid_vmlck</td>

2196

2197

<td>Locked memory size of the process

2198

2199

</td>

2200

</tr>

2201

2202

<td align="center">pid_vmhwm</td>

2203

2204

<td>Peak resident set size ("high water mark") of the process

2205

2206

</td>

2207

</tr>

2208

2209

<td align="center">pid_vmrss</td>

2210

2211

<td>Resident set size of the process

2212

2213

</td>

2214

</tr>

2215

2216

<td align="center">pid_vmdata</td>

2217

2218

<td>Data segment size of the process

2219

2220

</td>

2221

</tr>

2222

2223

<td align="center">pid_vmstk</td>

2224

2225

<td>Stack segment size of the process

2226

2227

</td>

2228

</tr>

2229

2230

<td align="center">pid_vmexe</td>

2231

2232

<td>Text segment size of the process

2233

2234

</td>

2235

</tr>

2236

2237

<td align="center">pid_vmlib</td>

2238

2239

<td>Shared library code size of the process

2240

2241

</td>

2242

</tr>

2243

2244

<td align="center">pid_vmpte</td>

2245

2246

<td>Page table entries size of the process

2247

2248

</td>

2249

</tr>

2250

2251

<td align="center">pid_write</td>

2252

2253

<td>Total number of bytes written by the process

2254

2255

</td>

1616

2256

</tr>

1617

2257

1618

2258

<td align="center">platform</td>

1627

2267

being modified as follows: 'input = input * factor +

1628

2268

offset'. Note that they have to be given as decimal values

1629

2269

(i.e. contain at least one decimal place).

1630

</td>

2270

2271

</td>

1631

2272

</tr>

1632

2273

1633

2274

<td align="center">pop3_unseen</td>

1634

2275

1635

2276

<td>Displays the number of unseen messages in your

1636

2277

global POP3 inbox by default. You can define individual

1637

POP3 inboxes seperately by passing arguments to this

2278

POP3 inboxes separately by passing arguments to this

1638

2279

object. Arguments are: "host user pass [-i interval (in

1639

seconds)] [-p port] [-e command] [-r retries]". Default

2280

seconds)] [-p port] [-e 'command'] [-r retries]". Default

1640

2281

port is 110, default interval is 5 minutes, and default

1641

2282

number of retries before giving up is 5. If the password is

1642

2283

supplied as '*', you will be prompted to enter the password

1643

2284

when Conky starts.

1644

</td>

2285

2286

</td>

1645

2287

</tr>

1646

2288

1647

2289

1648

2290

1649

2291

<td>Displays the amount of space (in MiB, 2^20) used

1650

2292

in your global POP3 inbox by default. You can define

1651

individual POP3 inboxes seperately by passing arguments to

2293

individual POP3 inboxes separately by passing arguments to

1652

2294

this object. Arguments are: "host user pass [-i interval

1653

(in seconds)] [-p port] [-e command] [-r retries]". Default

2295

(in seconds)] [-p port] [-e 'command'] [-r retries]". Default

1654

2296

port is 110, default interval is 5 minutes, and default

1655

2297

number of retries before giving up is 5. If the password is

1656

2298

supplied as '*', you will be prompted to enter the password

1657

2299

when Conky starts.

1658

</td>

2300

2301

</td>

1659

2302

</tr>

1660

2303

1661

2304

1662

2305

<td align="center">shell command</td>

1663

2306

<td>Executes a shell command one time before conky

1664

2307

displays anything and puts output as text.

1665

</td>

2308

2309

</td>

1666

2310

</tr>

1667

2311

1668

2312

<td align="center">processes</td>

1669

2313

1670

2314

<td>Total processes (sleeping and running)

1671

</td>

2315

2316

</td>

1672

2317

</tr>

1673

2318

2319

2320

2321

<td>Connects to a tcp port on a host (default is

2322

localhost), reads every char available at the moment and

2323

shows them.

2324

2325

</td>

2326

</tr>

2327

1674

2328

<td align="center">replied_mails</td>

1675

2329

<td align="center">(maildir)</td>

1676

2330

<td>Number of mails marked as replied in the

1677

2331

specified mailbox or mail spool if not. Only maildir type

1678

2332

mailboxes are supported, mbox type will return -1.

1679

</td>

2333

2334

</td>

1680

2335

</tr>

1681

2336

1682

2337

1683

<td align="center">url delay_in_minutes action (num_par

2338

<td align="center">uri interval_in_minutes action (num_par

1684

2339

(spaces_in_front))</td>

1685

<td>Download and parse RSS feeds. Action may be one

1686

of the following: feed_title, item_title (with num par),

1687

item_desc (with num par) and item_titles (when using this

1688

action and spaces_in_front is given conky places that many

1689

spaces in front of each item).

2340

<td>

2341

Download and parse RSS feeds. The interval may be

2342

a floating point value greater than 0, otherwise

2343

defaults to 15 minutes. Action may be one of the

2344

following: feed_title, item_title (with num par),

2345

item_desc (with num par) and item_titles (when using

2346

this action and spaces_in_front is given conky places

2347

that many spaces in front of each item). This object is

2348

threaded, and once a thread is created it can't be

2349

explicitly destroyed. One thread will run for each URI

2350

specified. You can use any protocol that Curl

2351

supports.

1690

2352

</td>

1691

2353

</tr>

1692

2354

1693

2355

<td align="center">running_processes</td>

1694

2356

1695

2357

<td>Running processes (not sleeping), requires Linux

1696

2358

2.6

1697

</td>

2359

2360

</td>

2361

</tr>

2362

2363

<td align="center">running_threads</td>

2364

2365

<td>Number of running (runnable) threads. Linux only.

2366

2367

</td>

1698

2368

</tr>

1699

2369

1700

2370

<td align="center">scroll</td>

1704

2374

may also contain variables. 'step' is optional and defaults

1705

2375

to 1 if not set. If a var creates output on multiple lines

1706

2376

then the lines are placed behind each other separated with

1707

a '|'-sign. Do NOT use vars that change colors or otherwise

1708

affect the design inside a scrolling text. If you want

1709

spaces between the start and the end of 'text', place them

1710

at the end of 'text' not at the front ("foobar" and "

1711

foobar" can both generate "barfoo" but "foobar " will keep

1712

the spaces like this "bar foo").

1713

</td>

2377

a '|'-sign. If you change the textcolor inside $scroll it

2378

will automatically have it's old value back at the end of

2379

$scroll. The end and the start of text will be separated by

2380

'length' number of spaces.

2381

2382

</td>

1714

2383

</tr>

1715

2384

1716

2385

<td align="center">seen_mails</td>

1718

2387

<td>Number of mails marked as seen in the specified

1719

2388

mailbox or mail spool if not. Only maildir type mailboxes

1720

2389

are supported, mbox type will return -1.

1721

</td>

2390

2391

</td>

1722

2392

</tr>

1723

2393

1724

2394

<td align="center">shadecolor</td>

1725

2395

<td align="center">(color)</td>

1726

2396

<td>Change shading color

1727

</td>

2397

2398

</td>

1728

2399

</tr>

1729

2400

1730

2401

<td align="center">smapi</td>

1735

2406

corresponding files' content. This is a very raw method of

1736

2407

accessing the smapi values. When available, better use one

1737

2408

of the smapi_* variables instead.

1738

</td>

2409

2410

</td>

1739

2411

</tr>

1740

2412

1741

2413

<td align="center">smapi_bat_bar</td>

1742

2414

<td align="center">(INDEX),(height),(width)</td>

1743

2415

<td>when using smapi, display the remaining capacity

1744

2416

of the battery with index INDEX as a bar.

1745

</td>

2417

2418

</td>

1746

2419

</tr>

1747

2420

1748

2421

<td align="center">smapi_bat_perc</td>

1751

2424

in percent of the battery with index INDEX. This is a

1752

2425

separate variable because it supports the 'use_spacer'

1753

2426

configuration option.

1754

</td>

2427

2428

</td>

1755

2429

</tr>

1756

2430

1757

2431

<td align="center">smapi_bat_power</td>

1761

2435

variable because the original read out value is being

1762

2436

converted from mW. The sign of the output reflects charging

1763

2437

(positive) or discharging (negative) state.

1764

</td>

2438

2439

</td>

1765

2440

</tr>

1766

2441

1767

2442

<td align="center">smapi_bat_temp</td>

1770

2445

of the battery with index INDEX in degree Celsius. This is

1771

2446

a separate variable because the original read out value is

1772

2447

being converted from milli degree Celsius.

1773

</td>

2448

2449

</td>

1774

2450

</tr>

1775

2451

1776

2452

<td align="center">sony_fanspeed</td>

1777

2453

1778

2454

<td>Displays the Sony VAIO fanspeed information if

1779

2455

sony-laptop kernel support is enabled. Linux only.

1780

</td>

2456

2457

</td>

1781

2458

</tr>

1782

2459

1783

2460

<td align="center">stippled_hr</td>

1784

2461

<td align="center">(space)</td>

1785

2462

<td>Stippled (dashed) horizontal line

1786

</td>

2463

2464

</td>

1787

2465

</tr>

1788

2466

1789

2467

1790

2468

1791

2469

<td>Amount of swap in use

1792

</td>

2470

2471

</td>

1793

2472

</tr>

1794

2473

1795

2474

<td align="center">swapbar</td>

1796

2475

<td align="center">(height),(width)</td>

1797

2476

<td>Bar that shows amount of swap in use

1798

</td>

2477

2478

</td>

1799

2479

</tr>

1800

2480

2481

<td align="center">swapfree</td>

2482

2483

<td>Amount of free swap

2484

2485

</td>

2486

</tr>

2487

1801

2488

<td align="center">swapmax</td>

1802

2489

1803

2490

<td>Total amount of swap

1804

</td>

2491

2492

</td>

1805

2493

</tr>

1806

2494

1807

2495

<td align="center">swapperc</td>

1808

2496

1809

2497

<td>Percentage of swap in use

1810

</td>

2498

2499

</td>

1811

2500

</tr>

1812

2501

1813

2502

<td align="center">sysname</td>

1814

2503

1815

2504

<td>System name, Linux for example

1816

</td>

2505

2506

</td>

1817

2507

</tr>

1818

2508

1819

2509

1820

2510

<td align="center">(width, (start))</td>

1821

2511

<td>Puts a tab of the specified width, starting from

1822

2512

column 'start'. The unit is pixels for both arguments.

1823

</td>

2513

2514

</td>

1824

2515

</tr>

1825

2516

1826

2517

1827

<td align="center">logfile lines (interval)</td>

1828

<td>Displays last N lines of supplied text text file.

1829

If interval is not supplied, Conky assumes 2x Conky's

1830

interval. Max of 30 lines can be displayed, or until the

1831

text buffer is filled.

1832

</td>

2518

<td align="center">logfile lines (next_check)</td>

2519

<td>Displays last N lines of supplied text file. The

2520

file is checked every 'next_check' update. If next_check is

2521

not supplied, Conky defaults to 2. Max of 30 lines can be

2522

displayed, or until the text buffer is filled.

2523

2524

</td>

1833

2525

</tr>

1834

2526

1835

2527

<td align="center">tcp_portmon</td>

1836

2528

<td align="center">port_begin port_end item (index)</td>

1837

<td>TCP port monitor for specified local ports. Port

1838

numbers must be in the range 1 to 65535. Valid items are:

1839

1840

1841

count- total number of connections

1842

in the range

1843

1844

rip- remote ip address

1845

1846

rhost- remote host name

1847

1848

rport- remote port number

1849

1850

rservice- remote service name from

1851

/etc/services

1852

1853

lip- local ip address

1854

1855

lhost- local host name

1856

1857

lport- local port number

1858

1859

lservice- local service name from

1860

/etc/services

1861

The connection index provides you with access

1862

to each connection in the port monitor. The monitor will

1863

return information for index values from 0 to n-1

1864

connections. Values higher than n-1 are simply ignored. For

1865

the "count" item, the connection index must be omitted. It

1866

is required for all other items.

1867

1868

Examples:

1869

1870

${tcp_portmon 6881 6999 count}-

1871

displays the number of connections in the bittorrent

1872

port range

1873

1874

${tcp_portmon 22 22 rip 0}- displays

1875

the remote host ip of the first sshd

1876

connection

1877

1878

${tcp_portmon 22 22 rip 9}- displays

1879

the remote host ip of the tenth sshd

1880

connection

1881

1882

${tcp_portmon 1 1024 rhost 0}-

1883

displays the remote host name of the first connection

1884

on a privileged port

1885

1886

${tcp_portmon 1 1024 rport 4}-

1887

displays the remote host port of the fifth connection

1888

on a privileged port

1889

1890

${tcp_portmon 1 65535 lservice 14}-

1891

displays the local service name of the fifteenth

1892

connection in the range of all ports

1893

Note that port monitor variables which share

1894

the same port range actually refer to the same monitor, so

1895

many references to a single port range for different items

1896

and different indexes all use the same monitor internally.

1897

In other words, the program avoids creating redundant

1898

monitors.</td>

2529

<td>

2530

TCP port (both IPv6 and IPv4) monitor for

2531

specified local ports. Port numbers must be in

2532

the range 1 to 65535. Valid items are:

2533

<ul>

2534

<li>

2535

count -

2536

2537

Total number of connections in the

2538

range

2539

</li>

2540

<li>

2541

rip -

2542

2543

Remote ip address

2544

</li>

2545

<li>

2546

rhost -

2547

2548

Remote host name

2549

</li>

2550

<li>

2551

rport -

2552

2553

Remote port number

2554

</li>

2555

<li>

2556

rservice -

2557

2558

Remote service name from

2559

/etc/services

2560

</li>

2561

<li>

2562

lip -

2563

2564

Local ip address

2565

</li>

2566

<li>

2567

lhost -

2568

2569

Local host name

2570

</li>

2571

<li>

2572

lport -

2573

2574

Local port number

2575

</li>

2576

<li>

2577

lservice -

2578

2579

Local service name from

2580

/etc/services

2581

</li>

2582

</ul>

2583

The connection index provides you with access to

2584

each connection in the port monitor. The monitor will

2585

return information for index values from 0 to n-1

2586

connections. Values higher than n-1 are simply ignored.

2587

For the "count" item, the connection index must be

2588

omitted. It is required for all other items.

2589

Examples:

2590

<ul>

2591

<li>

2592

${tcp_portmon 6881 6999

2593

count} -

2594

2595

Displays the number of connections in

2596

the bittorrent port range

2597

</li>

2598

<li>

2599

${tcp_portmon 22 22 rip 0} -

2600

2601

Displays the remote host ip of the

2602

first sshd connection

2603

</li>

2604

<li>

2605

${tcp_portmon 22 22 rip 9} -

2606

2607

Displays the remote host ip of the

2608

tenth sshd connection

2609

</li>

2610

<li>

2611

${tcp_portmon 1 1024 rhost

2612

0} -

2613

2614

Displays the remote host name of the

2615

first connection on a privileged port

2616

</li>

2617

<li>

2618

${tcp_portmon 1 1024 rport

2619

4} -

2620

2621

Displays the remote host port of the

2622

fifth connection on a privileged port

2623

</li>

2624

<li>

2625

${tcp_portmon 1 65535 lservice

2626

14} -

2627

2628

Displays the local service name of the

2629

fifteenth connection in the range of all

2630

ports

2631

</li>

2632

</ul>

2633

Note that port monitor variables which share the

2634

same port range actually refer to the same monitor, so

2635

many references to a single port range for different

2636

items and different indexes all use the same monitor

2637

internally. In other words, the program avoids creating

2638

redundant monitors.

2639

</td>

1899

2640

</tr>

1900

2641

1901

2642

<td align="center">templateN</td>

1902

2643

1903

<td>Evaluate the content of the templateN

1904

configuration variable (where N is a value between 0 and 9,

1905

inclusively), applying substitutions as described in the

1906

documentation of the corresponding configuration variable.

1907

The number of arguments is optional, but must match the

1908

highest referred index in the template. You can use the

1909

same special sequences in each argument as the ones valid

1910

for a template definition, e.g. to allow an argument to

1911

contain a whitespace. Also simple nesting of templates is

1912

possible this way.

2644

<td>

2645

Evaluate the content of the templateN

2646

configuration variable (where N is a value between 0

2647

and 9, inclusively), applying substitutions as

2648

described in the documentation of the corresponding

2649

configuration variable. The number of arguments is

2650

optional, but must match the highest referred index in

2651

the template. You can use the same special sequences in

2652

each argument as the ones valid for a template

2653

definition, e.g. to allow an argument to contain a

2654

whitespace. Also simple nesting of templates is

2655

possible this way.

2656

Here are some examples of template

2657

definitions:

2658

<ul>

2659

<li>template0 $\1\2</li>

2660

<li>template1 \1: ${fs_used \2} / ${fs_size

2661

\2}</li>

2662

<li>template2 \1 \2</li>

2663

</ul>

2664

The following list shows sample usage of the

2665

templates defined above, with the equivalent syntax

2666

when not using any template at all:

2667

2668

2669

2670

2671

using template

2672

same without template

2673

2674

2675

2676

2677

${template0 node name}

2678

$nodename

2679

2680

2681

${template1 root /}

2682

root: ${fs_free /} / ${fs_size

2683

/}

2684

2685

2686

2687

${template1

2688

${template2\ disk\ root}

2689

/}

2690

2691

2692

disk root:

2693

${fs_free /} / ${fs_size

2694

/}

2695

2696

2697

2698

2699

1913

2700

</td>

1914

2701

</tr>

1915

2702

1916

2703

<td align="center">texeci</td>

1917

2704

<td align="center">interval command</td>

1918

2705

<td>Runs a command at an interval inside a thread and

1922

2709

longer then the time it takes your script to execute. For

1923

2710

example, if you have a script that take 5 seconds to

1924

2711

execute, you should make the interval at least 6 seconds.

1925