~ubuntu-branches/ubuntu/wily/sflphone/wily

<para>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation Licence (GFDL), Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You can find a copy of the GFDL at this <ulink type="help" url="ghelp:fdl">link</ulink> or in the file COPYING-DOCS distributed with this manual.</para>

<para>This manual is part of a collection of GNOME manuals distributed under the GFDL. If you want to distribute this manual separately from the collection, you can do so by adding a copy of the licence to the manual, as described in section 6 of the licence.</para>

</legalnotice>

<firstname>Pierre-Luc</firstname>

<surname>Bacon</surname>

<address><email>pierre-luc.bacon@savoirfairelinux.com</email></address>

</affiliation>

</author>

<firstname>Emmanuel</firstname>

<surname>Milou</surname>

<address><email>emmanuel.milou@savoirfairelinux.com</email></address>

</affiliation>

</author>

<firstname>Jérémy</firstname>

<surname>Quentin</surname>

<address><email>jeremy.quentin@savoirfairelinux.com</email></address>

</affiliation>

</author>

<firstname>Alexandre</firstname>

<surname>Savard</surname>

<address><email>alexandre.savard@savoirfairelinux.com</email></address>

</affiliation>

</author>

</authorgroup>

<revnumber>SFLphone Manual v1.0.1</revnumber>

<date>March 2010</date>

<para role="author">SFLphone team</para>

<para role="publisher">Savoir-faire Linux</para>

<para>Minor changes</para>

</revdescription>

</revision>

<revnumber>SFLphone Manual v1.0</revnumber>

<date>September 2009</date>

<para role="author">SFLphone team</para>

<para role="publisher">Savoir-faire Linux</para>

</revdescription>

</revision>

</revhistory>

<releaseinfo>This manual describes SFLphone version &appversion;.</releaseinfo>

</articleinfo>

100

101

102

<primary>SFLphone</primary>

103

</indexterm>

104

105

106

<title>Introduction</title>

107

<para>

108

<application>SFLphone</application> is a SIP/IAX2 softphone and VoIP client for GNU/Linux. It aims at being a robust enterprise-class desktop phone and has been designed with a hundred-calls-a-day receptionist in mind.

109

</para>

110

<para>

111

<application>SFLphone</application> is a free software and is distributed under the GNU General Public License version 3. It is developed by Savoir-Faire Linux, a Canadian Linux consulting company, in partnership with the global community.

112

</para>

113

<para>

114

Among the many features we developed for you, we could

115

highlight the high definition sound (wide-band audio

116

codecs - speex, G722, Celt), multiple conference call,

117

audio recording, voicemail notification, and call history.

118

More than a simple softphone, <application>SFLphone</application> supports advanced enterprise-class call features: unlimited number of calls, call transfer, and on/off hold option.

119

</para>

120

<para>

121

This release also provides advanced security features (secure RTP and TLS).

122

</para>

123

124

<para>

125

Besides the native ALSA interface, <application>SFLphone</application> now fully supports PulseAudio sound server so you could experience the great possibilities it offers (sound mixing, per application volume control, ...).

126

</para>

127

</sect1>

128

129

130

<title>Getting started</title>

131

<para>

132

The first time you start up SFLphone, you will be ask to complete a wizard to set up your(s) account(s). This account configuration manager offers you two possibilities:

133

134

135

<para><guilabel>Create a free SIP/IAX2 account on sflphone.org</guilabel></para>

136

<para>Savoir-faire Linux provides free SIP/IAX2 accounts on an Asterisk server.

137

By clicking this option, you will be created an account to make test calls. The echo service is available, you may also call other accounts registered to the same server.</para>

138

<para>By filling out your email address information, you will receive voicemail notifications by email. This information is not mandatory to get your free account.</para>

139

</listitem>

140

141

<para><guilabel>Register an existing SIP or IAX2 account</guilabel></para>

142

<para>Click there if you already have an account and you want to use it with SFLphone.

143

You will be prompted to select the account type (SIP or IAX2) and to fill out your account information. <application>SFLphone</application> will then try to register it so you could start using it.</para>

144

</listitem>

145

</itemizedlist>

146

</para>

147

<para>

148

You can always access the account creation manager: <menuchoice><guimenu>Edit</guimenu> <guimenuitem>Account creation assistant</guimenuitem></menuchoice>.

149

</para>

150

</sect1>

151

152

153

<title>Managing your accounts</title>

154

<para>

155

<application>SFLphone</application> supports both IAX2

156

and SIP accounts.

157

</para>

158

159

160

<title>Basic features</title>

161

162

<title>Creating a new account</title>

163

<para>To create a new account, perform the following steps:</para>

164

165

<listitem><para>Choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Manage accounts</guimenuitem></menuchoice>.</para></listitem>

166

<listitem><para>Click on the <guilabel>Add</guilabel> button. Fill out the following information:</para>

167

168

169

<para><guilabel>Alias</guilabel></para>

170

<para>The name to identify your account in the list. It is not used for the communications</para>

171

</listitem>

172

173

<para><guilabel>Protocol</guilabel></para>

174

<para>Select SIP or IAX2. The most commonly used protocol is SIP.</para>

175

</listitem>

176

177

178

<para>The name or the IP address of the server you want to register on.</para>

179

</listitem>

180

181

182

<para>The name or the extension for your account.</para>

183

</listitem>

184

185

<para><guilabel>Password</guilabel></para>

186

<para>The password for your account.</para>

187

</listitem>

188

189

<para><guilabel>Voicemail number</guilabel></para>

190

<para>The number to dial to reach your voicemail. Example: 888, or *97. It will be used as a quick dial button on the main interface.</para>

191

</listitem>

192

</itemizedlist>

193

</listitem>

194

<listitem><para>Click the <menuchoice><guimenu>Apply</guimenu></menuchoice> button.</para></listitem>

195

</orderedlist>

196

<para>You may now check the state of your account(s). If it is registered, you may now use it to make calls.</para>

197

<note>You can setup as many accounts as you wish.</note>

198

</sect3>

199

200

201

<title>Editing a configured account</title>

202

<para>To edit an existing account, perform the following steps:</para>

203

204

<listitem><para>Choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Manage accounts</guimenuitem></menuchoice>.</para></listitem>

205

<listitem><para>Select in the list the account you would like to edit, then click on the <guilabel>Edit</guilabel> button.</para></listitem>

206

<listitem><para>Make your modifications, then click on the <guilabel>Apply</guilabel> button.</para></listitem>

207

</orderedlist>

208

</sect3>

209

210

211

<title>Deleting an account</title>

212

<para>To delete an existing account, perform the following steps:</para>

213

214

<listitem><para>Choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Manage accounts</guimenuitem></menuchoice>.</para></listitem>

215

<listitem><para>Select in the list the account you would like to delete, then click on the <guibutton>Delete</guibutton> button.</para></listitem>

216

</orderedlist>

217

</sect3>

218

219

220

<title>Selecting a default account</title>

221

<para>Since it is possible to have an unlimited number of registered accounts at the same time, which account will be used when making a call ? You can not only set up a default account to be used every time you are making a call, but an entire priority list. To do that, perform the following steps:</para>

222

223

<listitem><para>Choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Manage accounts</guimenuitem></menuchoice> to access the accounts list.</para></listitem>

224

225

<para>The first account in the account in list will be used as the default account to make calls with. If it is not registered, SFLphone will try to use the second in the list, if still not registered, the third, and so one ...</para>

226

<para>To reorder the accounts as you wish, select an account and click on the <menuchoice><guimenu>Up</guimenu></menuchoice> or <menuchoice><guimenu>Down</guimenu></menuchoice> button.</para>

227

</listitem>

228

</orderedlist>

229

<para>Note that you also can select an account to make a call with when dialing by right-clicking on it.</para>

230

</sect3>

231

</sect2>

232

233

234

<title>Advanced features</title>

235

<para>These features are only available with SIP.</para>

236

<para>Follow the indications to <link linkend='account_edit'>edit an account</link> and choose the <guimenu>Advanced</guimenu> tab.</para>

237

238

239

<title>Advanced features configuration panel</title>

240

241

242

243

244

</imageobject>

245

</mediaobject>

246

</screenshot>

247

</figure>

248

249

250

<title>Registration</title>

251

<para>You may set the expires header for a contact.</para>

252

<para>It basically represents the duration your registration will remain active. If you don't register again within that time, calls will no longer be routed to you. It should not be used as a keepalive mechanism though. The default value is 600 seconds (ten minutes).</para>

253

<note><para>Some VoIP services requires that you set this value at at least 1600 seconds (e.g. the French VoIP server freephonie.net).</para>

254

</note>

255

</sect3>

256

257

<title>Network</title>

258

<para>This section enables you to set advanced network parameters.</para>

259

260

261

<term><guilabel>Local address</guilabel></term>

262

<listitem><para>it is initialized to your private/local IP address. Calls will be routed to this address by default.</para></listitem>

263

</varlistentry>

264

265

<term><guilabel>Local port</guilabel></term>

266

<listitem><para>It is initialized to the default SIP port, 5060.</para></listitem>

267

</varlistentry>

268

269

<term><guilabel>Set published address and port</guilabel></term>

270

271

272

<listitem><para>Using STUN</para>

273

<para>If enabled, the core will try to initialize an UDP transport on the mapped address/port number that the NAT (Network Address Translator) has allocated to <application>SFLphone</application>.</para></listitem>

274

<listitem><para>Same as local parameters</para>

275

</listitem>

276

<listitem><para>Manually</para>

277

</listitem>

278

</itemizedlist>

279

</listitem>

280

</varlistentry>

281

</variablelist>

282

</sect3>

283

</sect2>

284

285

<title>Security features</title>

286

<para>These features are only available with SIP.</para>

287

<para>Follow the indications to <link linkend='account_edit'>edit an account</link> and choose the <guimenu>Security</guimenu> tab.</para>

288

289

290

<title>Security features configuration panel</title>

291

292

293

294

295

</imageobject>

296

</mediaobject>

297

</screenshot>

298

</figure>

299

300

301

302

<title>Credentials</title>

303

<para>SFLphone supports multiple realms.</para>

304

</sect3>

305

306

307

<title>Security </title>

308

<para>Please refer to the section <link linkend="detailed_security_features">Security features</link> for detailed information about security features.</para>

309

</sect3>

310

</sect2>

311

</sect1>

312

313

314

<title>Call features</title>

315

316

<para>The following features are available with both SIP and IAX2 accounts.</para>

317

318

<sect2><title>Dialing a number</title>

319

320

321

<title>Dial button</title>

322

323

324

325

326

</imageobject>

327

</mediaobject>

328

</screenshot>

329

</figure>

330

331

332

<para>You may have an unlimited number of calls at the same time, even with different accounts.</para>

333

<para>To create a new call when you already have a current call, just click on the <guilabel>Dial</guilabel> button. The current call will automatically be put on hold.</para>

334

335

336

<title>Make an other call</title>

337

338

339

340

341

</imageobject>

342

</mediaobject>

343

</screenshot>

344

</figure>

345

346

347

<para>Keyboard shortcut to perform this action: <guimenuitem><accel>NUMPAD</accel></guimenuitem> or almost any keys.</para>

348

349

</sect2>

350

351

<sect2><title>Calling a number</title>

352

353

354

355

<title>Call button</title>

356

357

358

359

360

</imageobject>

361

</mediaobject>

362

</screenshot>

363

</figure>

364

365

366

<para>Keyboard shortcut to perform this action: <guimenuitem><accel>Enter</accel></guimenuitem>.</para>

367

368

</sect2>

369

370

<sect2><title>Answering a call</title>

371

372

373

<title>Answer button</title>

374

375

376

377

378

</imageobject>

379

</mediaobject>

380

</screenshot>

381

</figure>

382

383

384

<para>Keyboard shortcut to perform this action: <guimenuitem><accel>Enter</accel></guimenuitem>.</para>

385

</sect2>

386

387

<sect2><title>Hanging up a call</title>

388

389

390

<title>Hangup button</title>

391

392

393

394

395

</imageobject>

396

</mediaobject>

397

</screenshot>

398

</figure>

399

400

401

<para>Keyboard shortcut to perform this action: <guimenuitem><accel>ESC</accel></guimenuitem>.</para>

402

</sect2>

403

404

<sect2><title>Refusing a call</title>

405

406

<para>When you refuse a call, your caller is automatically redirected to your voicemail box, if applicable.</para>

407

408

409

410

<title>Refuse button</title>

411

412

413

414

415

</imageobject>

416

</mediaobject>

417

</screenshot>

418

</figure>

419

420

421

<para>Keyboard shortcut to perform this action: <guimenuitem><accel>ESC</accel></guimenuitem>.</para>

422

</sect2>

423

424

425

<sect2><title>Holding on/off a call</title>

426

427

428

<title>Hold on button</title>

429

430

431

432

433

</imageobject>

434

</mediaobject>

435

</screenshot>

436

</figure>

437

438

439

440

<title>Hold off button</title>

441

442

443

444

445

</imageobject>

446

</mediaobject>

447

</screenshot>

448

</figure>

449

450

</sect2>

451

452

<sect2><title>Transferring a call</title>

453

454

455

<title>Transfer button</title>

456

457

458

459

460

</imageobject>

461

</mediaobject>

462

</screenshot>

463

</figure>

464

465

466

<para>Then type the number you want to transfer the current call to.</para>

467

468

469

<title>Validate the transfer</title>

470

471

472

473

474

</imageobject>

475

</mediaobject>

476

</screenshot>

477

</figure>

478

479

480

<para>And press <guimenuitem><accel>Enter</accel></guimenuitem>. Clicking again on the transfer button cancels the transfer.</para>

481

482

</sect2>

483

484

<sect2><title>Record a call</title>

485

486

<para>Go to <menuchoice><guimenu>Edit</guimenu><guimenuitem>Preferences</guimenuitem> <guimenuitem>Audio</guimenuitem></menuchoice> to configure the recordings destination folder.</para>

487

488

489

490

<title>Record settings</title>

491

492

493

494

495

</imageobject>

496

</mediaobject>

497

</screenshot>

498

</figure>

499

500

501

502

503

<title>Record button</title>

504

505

506

507

508

</imageobject>

509

</mediaobject>

510

</screenshot>

511

</figure>

512

513

</sect2>

514

515

<sect2><title>Voicemail quick dial</title>

516

517

<caution><para>This feature is available only if you fill out the voicemail number information for your default account.</para></caution>

518

519

520

521

<title>Voicemail button</title>

522

523

524

525

526

</imageobject>

527

</mediaobject>

528

</screenshot>

529

</figure>

530

531

</sect2>

532

533

534

<sect2 id="directip"><title>Direct IP calls</title>

535

<para>A direct IP call is a call established between two peers without any accounts. When dialing, such a call must prefixed with <guilabel>sip:</guilabel>.</para>

536

537

<para>Direct IP calls use SIP protocol to establish communication and RTP to transport data. It is right now not available with IAX2.</para>

538

539

<para>Go to <menuchoice><guimenu>Edit</guimenu><guimenuitem>Preferences</guimenuitem> <guimenuitem>Direct IP calls</guimenuitem></menuchoice> to configure the advanced security features for this kind of calls.</para>

540

</sect2>

541

542

<sect2 id="conferencecall"><title>Conference calls</title>

543

<para>SFLphone now supports conference call hosting

544

integrating server like features in a simple GUI.

545

</para>

546

<para>

547

548

549

<para><guilabel>Create a conference</guilabel></para>

550

<para>To host a conference, simply drag and drop one call

551

on another. Additional participants are

552

added the same way, dragging a call on the

553

conference icon.

554

</para>

555

556

557

<title>Creating a new conference</title>

558

559

560

561

562

</imageobject>

563

</mediaobject>

564

</screenshot>

565

</figure>

566

567

568

569

<title>Conference call</title>

570

571

572

573

574

</imageobject>

575

</mediaobject>

576

</screenshot>

577

</figure>

578

579

</listitem>

580

581

<para><guilabel>Leave a conference</guilabel></para>

582

<para>

583

SFLphone conference model let you leave a conference that

584

you are currently hosting to answer any other incoming

585

communication or even initiate new ones. The conference is

586

not interrupted, double clicking the conference icon

587

let you reintroduce it at any moment.

588

</para>

589

590

591

<title>Conference detached</title>

592

593

594

595

596

</imageobject>

597

</mediaobject>

598

</screenshot>

599

</figure>

600

601

602

603

<title>Conference attached</title>

604

605

606

607

608

</imageobject>

609

</mediaobject>

610

</screenshot>

611

</figure>

612

613

</listitem>

614

615

<para><guilabel>Multiple conference</guilabel></para>

616

<para>

617

SFLphone supports multiple conferences running

618

simultaneously. Two conferences can be joined the same way

619

they are created, dragging one on the

620

other.

621

</para>

622

</listitem>

623

624

<para><guilabel>Hangup/Hold a conference</guilabel></para>

625

<para>

626

Select the conference icon and press hangup/hold button

627

on the toolbar. The selected action is applied on every

628

conference participants.

629

</para>

630

</listitem>

631

</itemizedlist>

632

</para>

633

</sect2>

634

635

636

</sect1>

637

638

639

640

<title>Security features</title>

641

642

643

644

<title>SRTP and ZRTP, the big picture</title>

645

<para>RTP is the underlying protocol that is used in pair with the widely used SIP protocol to carry voice data. RTP alone does not provide any security features.</para>

646

<para>Details for implementing Secure RTP (SRTP) were described independently in a separate document (RFC). However, in this paper, one aspect was deliberately left unspecified: how should the encryption keys be exchanged between the two parties involved in a secure RTP session ?</para>

647

648

<para>Multiple solutions were proposed to fill in that blank. Among them, are SDES (RFC4568) and ZRTP which are probably the most popular today. For the 0.9.7 release, SFLphone integrates support for Secure RTP through the ZRTP protocol, and SDES is expected to be implemented in the very few next releases.</para>

649

650

<para>As of today, blueprints for ZRTP are still laid out and are recognized under the name "zrtp-draftzimmerman" in the RFC machine. The author of ZRTP is Phil Zimmermann, that same person who brought us PGP. Therefore, it is not surprising that he designed ZRTP as an anti-PKI solution for key exchange.</para>

651

652

<para>ZRTP makes possible for two parties to automatically establish a shared secret in a very simple way from the user's point of view. Indeed under SFLphone no special configuration is needed, apart from enabling the option itself.</para>

653

654

<para>If you want to use ZRTP, please take note that if you are connecting to a PBX, this one must have been configured to support ZRTP. Unfortunately, security for VoIP communications is still young and chances are that your PBX software won't support it.</para>

655

656

<para>This does not mean that you want be able to benefit from ZRTP ! In fact, it turns out that you will be able to use it, as long as the server does not need to decode the RTP stream. This is often the case when the person you are calling to uses a codec that you don't support. In that case, the server will need to transcode the RTP packets and obviously need to be able to handle the ZRTP stream.</para>

657

658

<para>Obviously, if you are calling another user (for example by prefixing the number with "sip:") directly, then this one will have to support ZRTP as well if you want to use it.</para>

659

</sect3>

660

661

662

<title>Enabling SRTP/ZRTP</title>

663

<para>To enable ZRTP per account basis, perform the following steps:</para>

664

665

<listitem><para>Choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Manage accounts</guimenuitem></menuchoice>.</para></listitem>

666

<listitem><para>Select in the list the account you would like to edit, then click on the <guilabel>Edit</guilabel> button.</para></listitem>

667

<listitem><para>Select the <guilabel>Security</guilabel> tab.</para></listitem>

668

<listitem><para>Select <guilabel>ZRTP</guilabel> from the select box named <guilabel>SRTP Key Exchange</guilabel>.</para></listitem>

669

</orderedlist>

670

671

672

<title>Enabling SRTP</title>

673

674

675

676

677

</imageobject>

678

</mediaobject>

679

</screenshot>

680

</figure>

681

682

</sect3>

683

684

685

<title>Configuration options</title>

686

687

<para>After enabling SRTP, click the <guilabel>Preferences</guilabel> button.</para>

688

<para>For basic usage, one don't have to worry about that.</para>

689

690

691

692

<title>ZRTP configuration panel</title>

693

694

695

696

697

</imageobject>

698

</mediaobject>

699

</screenshot>

700

</figure>

701

702

703

704

705

706

<term><guilabel>Send Hello Hash in SDP</guilabel></term>

707

<listitem><para>Selecting this option will cause the program to compute an hash function over the "Hello" packet and send it as an SDP field "zrtp-hash:". The remote end might be interested in getting this value to add an additional layer of protection based on another communication channel. Upon receiving this value, the remote point can compute the hash function on the received hello packet and compare it.</para>

708

<para>Take note that for 0.9.7, SFLphone does not perform the comparison on its side.</para></listitem>

709

</varlistentry>

710

711

712

<term><guilabel>Ask user to confirm SAS</guilabel></term>

713

<listitem><para>The short authentication mechanism is at the heart of the ZRTP protocol. Not requiring the user to manually check the SAS value presents a security risk over Man in the Middle type of attacks.</para>

714

715

<para>Disabling this option will stop the program from prompting the user with the SAS.</para>

716

717

<para>Such an option was motivated to be developed at that time by the the state of the libzrtpcpp library that SFLphone was making use of. It is only from version x.x that this library can cache results of SAS computation between two peers.</para>

718

</listitem>

719

</varlistentry>

720

721

722

<term><guilabel>Display SAS once for hold event</guilabel></term>

723

<listitem><para>When call is put on hold, the RTP stream is stopped and reinitiated later. From the ZRTP point of view, this appears as a "new call". Therefore, the SAS will be redisplayed unless this option is selected.</para></listitem>

724

</varlistentry>

725

726

<term><guilabel>ZRTP for direct peer-to-peer calls</guilabel></term>

727

<listitem><para>If you want to use ZRTP for calls that are placed directly to a user (without an intervening PBX), you must enable the option under the "Direct IP Calls" tab in the "configuration" window, available from the "edit" menu.</para>

728

729

<para>Configuration instruction from that point are the same as for configured accounts.</para>

730

</listitem>

731

</varlistentry>

732

</variablelist>

733

</sect3>

734

</sect2>

735

736

737

738

</sect2>

739

</sect1>

740

741

742

743

744

<title>Audio configuration</title>

745

<para>

746

ALSA and PulseAudio native interfaces are available.

747

</para>

748

749

<sect2><title>Pulseaudio</title>

750

<para>

751

</para>

752

</sect2>

753

754

755

<para>

756

</para>

757

</sect2>

758

</sect1>

759

760

761

<title>Codecs overview</title>

762

<para>SFLphone supports several widely used audio codecs:</para>

763

<para>

764

765

766

767

<para>

768

ITU-T telephony standard PCM formats, 8kHz, 64

769

kbit/s, using logarithmic byte compression algorithm.

770

</para>

771

</listitem>

772

773

774

<para>

775

Global System for Mobile communications (GSM)

776

narrowband 8kHz standard based on linear prediction encoding.

777

</para>

778

</listitem>

779

780

781

<para>

782

ITU-T standard wideband 16kHz standard based on linear prediction.

783

</para>

784

</listitem>

785

786

<para><guilabel>SPEEX</guilabel></para>

787

<para>

788

High quality voice encoding/decoding available

789

in narrowband 8kHz, wideband 16kHz (HD Voice),

790

and ultra-wideband 32 kHz.

791

Integrate additional features such as Variable Bit

792

Rate (VBR) and noise reduction.

793

</para>

794

</listitem>

795

796

797

<para>

798

799

</para>

800

</listitem>

801

</itemizedlist>

802

</para>

803

804

</sect1>

805

806

807

<title>Address books</title>

808

809

<title>Enable the address book support</title>

810

<para>To enable the address book, perform the following steps:</para>

811

812

813

<para>Choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Preferences</guimenuitem></menuchoice>.

814

</para>

815

</listitem>

816

817

<para>Select the <menuchoice><guimenu>Address book</guimenu></menuchoice> tab.

818

</para>

819

</listitem>

820

821

<para>Check the <guilabel>Use Evolution address books</guilabel> box.</para>

822

</listitem>

823

</orderedlist>

824

<para>Every address books you configured in Evolution will be now available in <application>SFLphone</application>. Please be sure you selected at least one address book.</para>

825

</sect2>

826

827

828

<title>Available options</title>

829

<para>In <menuchoice><guimenu>Edit</guimenu><guimenuitem>Preferences</guimenuitem><guimenuitem>Address book</guimenuitem></menuchoice>, you may select one or all of the following options:</para>

830

831

832

<term><guilabel>Display contact photo if available</guilabel></term>

833

834

The contact photo will be displayed as a thumbnail beside the phone number.

835

</para></listitem>

836

</varlistentry>

837

838

<term><guilabel>Fields from Evolution's address book</guilabel></term>

839

840

You may use one or all of these following information from your contact.</para>

841

842

<listitem><para>Work phone number</para></listitem>

843

<listitem><para>Home phone number</para></listitem>

844

<listitem><para>Mobile phone number</para></listitem>

845

</itemizedlist>

846

</listitem>

847

</varlistentry>

848

</variablelist>

849

</sect2>

850

851

852

<title>Using the address book</title>

853

854

855

<para>On the toolbar, click on the following button to display the address book window:</para>

856

857

858

859

<title>Address book toolbar button</title>

860

861

862

863

864

</imageobject>

865

</mediaobject>

866

</screenshot>

867

</figure>

868

869

</listitem>

870

871

872

<para>Search for a contact</para>

873

</listitem>

874

875

876

<para>New entries should have appeared in the window. Double click on it to call the contact. You may also <menuchoice><guimenu>Right click</guimenu><guimenuitem>Edit before calling</guimenuitem></menuchoice> to modify the entry before calling.</para>

877

</listitem>

878

</orderedlist>

879

</sect2>

880

</sect1>

881

882

883

<title>Preferences</title>

884

885

<para>Go to <menuchoice><guimenu>Edit</guimenu><guimenuitem>Preferences</guimenuitem></menuchoice> to access the configuration panel.</para>

886

<para>Each section is detailed below.</para>

887

888

<sect2>

889

<title>General</title>

890

<para>This section provides the user general settings regarding the application.</para>

891

<sect3><title>Desktop Notifications</title>

892

893

894

<title>Desktop notifications options</title>

895

896

897

898

899

</imageobject>

900

</mediaobject>

901

</screenshot>

902

</figure>

903

904

905

906

907

908

<term><guilabel>Enable notifications</guilabel></term>

909

910

Both clients use their desktop environment notification system. If checked, you will receive desktop notifications for events such as incoming calls and system messages.

911

</para>

912

913

<title>Example of an incoming call notification</title>

914

915

916

917

918

</imageobject>

919

</mediaobject>

920

</screenshot>

921

</figure>

922

</listitem>

923

</varlistentry>

924

925

<term><guilabel>Enable voicemail notifications</guilabel></term>

926

927

The voicemail notifications are handled separately. If checked, you will be notified with the number of unread voicemails for your accounts.

928

</para>

929

930

<title>Example of a voicemail notification</title>

931

932

933

934

935

</imageobject>

936

</mediaobject>

937

</screenshot>

938

</figure>

939

940

941

</listitem>

942

</varlistentry>

943

</variablelist>

944

</sect3>

945

946

<sect3><title>System Tray Icon</title>

947

948

949

<title>System tray options</title>

950

951

952

953

954

</imageobject>

955

</mediaobject>

956

</screenshot>

957

</figure>

958

959

960

961

962

963

<term><guilabel>Popup main window on incoming call</guilabel></term>

964

965

If SFLphone is closed on the system tray, pops the main window up on foreground when receiving an incoming call.

966

</para></listitem>

967

</varlistentry>

968

969

<term><guilabel>Never popup main window</guilabel></term>

970

971

If SFLphone is closed on the system tray, never pops the main window up on foreground when receiving an incoming call.

972

</para></listitem>

973

</varlistentry>

974

975

<term><guilabel>Hide SFLphone window on startup</guilabel></term>

976

977

On startup, SFLphone will go directly on the system tray.

978

</para></listitem>

979

</varlistentry>

980

981

</variablelist>

982

983

</sect3>

984

985

986

<sect3><title>Calls history</title>

987

988

989

<title>Calls history options</title>

990

991

992

993

994

</imageobject>

995

</mediaobject>

996

</screenshot>

997

</figure>

998

999

1000

1001

1002

<term><guilabel>Keep my history for at least n days</guilabel></term>

1003

1004

If checked, calls will be kept up to N days in the history. You may select a custom number of days. Do not check it if you don't want to use this feature.

1005

</para></listitem>

1006

</varlistentry>

1007

</variablelist>

1008

</sect3>

1009

1010

<sect3><title>Configuration File</title>

1011

1012

1013

<title>Configuration file options</title>

1014

1015

1016

1017

1018

</imageobject>

1019

</mediaobject>

1020

</screenshot>

1021

</figure>

1022

1023

1024

1025

1026

<term><guilabel>Store SIP credentials as MD5 hash</guilabel></term>

1027

1028

If checked, your password information will be encrypted in the configuration file, instead of plain text.

1029

</para></listitem>

1030

</varlistentry>

1031

</variablelist>

1032

1033

1034

</sect3>

1035

</sect2>

1036

1037

<sect2>

1038

<title>Audio</title>

1039

1040

</sect2>

1041

1042

<sect2>

1043

<title>Address book</title>

1044

1045

<para>Refer to the <link linkend='addressbook'>Address books</link> section for more information.</para>

1046

</sect2>

1047

1048

<sect2>

1049

<title>Hooks</title>

1050

1051

</sect2>

1052

1053

<sect2>

1054

<title>Network</title>

1055

1056

</sect2>

1057

1058

<sect2>

1059

<title>Direct IP calls</title>

1060

<para>Refer to the <link linkend='directip'>Direct IP calls</link> section for more information.</para>

1061

</sect2>

1062

</sect1>

1063

1064

1065

</article>

Older »