← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to doc/man/config.rst

  • Committer: David Coles
  • Date: 2009-12-09 04:48:43 UTC
  • Revision ID: coles.david@gmail.com-20091209044843-g5onu97blkgk5pbv
Some examples for unusual config parameters

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/config.rst
32
32
 
33
33
Most of the configuration of IVLE is done by editing the file 
34
34
:file:`ivle.conf`, located by default in :file:`/etc/ivle/ivle.conf`. These 
35
 
settings are required as part of the :ref:`install process <ref-install>` and 
36
 
for actual running of IVLE.
 
35
settings are required as part of the :ref:`install process <ref-install>`, 
 
36
though the :ref:`admin script <ref-admin-scripts>` :program:`ivle-config` can 
 
37
be used to propagate most of these settings.
37
38
 
38
39
It uses the `ConfigObj`_ text format which is heavily based on the 'INI' text 
39
 
format.
 
40
format. Of particular note, lists with single items need to be terminated 
 
41
with a ',' otherwise it will be treated as a list of characters (usually not 
 
42
what is desired).
40
43
 
41
44
.. _ConfigObj: http://www.voidspace.org.uk/python/configobj.html
42
45
 
328
331
    :type: string_list(default=list())
329
332
 
330
333
    A list of extra source locations to be added to the jail builder (such as 
331
 
    for site specific packages).
 
334
    for site specific packages). For example, 'deb 
 
335
    http://ppa.launchpad.net/wgrant/ivle/ubuntu/ hardy main,'.
332
336
 
333
337
.. describe:: extra_packages
334
338
 
335
339
    :type: string_list(default=list())
336
340
 
337
341
    A list of extra packages to be installed in addition to the core packages 
338
 
    required for IVLE.
339
 
 
340
 
.. FIXME: Is this correct. Is it extra user packages (such as
341
 
    python-scipy) or all packages that aren't in a standard debootstrap build 
342
 
    (such as python-svn and python-cjson)?.
 
342
    required for IVLE. For example, 'python-scipy, python-networkx,'
343
343
 
344
344
.. describe:: extra_keys
345
345
 
347
347
 
348
348
    Any extra package signing keys to accept as correctly validate installed 
349
349
    packages.  Typically used for validating ``extra_sources`` packages.
350
 
    
351
 
    .. note:: Cannot have triple-quoted list members.
 
350
 
 
351
    Keys can be provided in tripple quoted blocks. For multiple keys, simply 
 
352
    concatinate the key blocks. For example::
 
353
 
 
354
        extra_keys = '''-----BEGIN PGP PUBLIC KEY BLOCK-----
 
355
        Version: SKS 1.0.10
 
356
 
 
357
        mI0ESXMxaQEEAMdundmJeTMUcB6fRXGQ3WJH+5hlfj3ehurF3u0ubr4sQpxfJvl6/KV4UcOC
 
358
        RvK4aufNInJxKrT6xvzdMNE9z5NO/ZVZdkr2NfcRO/0Yxgmaft9qjxfV+3NEBrvJkqm8ApVO
 
359
        hsxFW6VWyeHBELSiNxNGToPp+2g3i5VAlWbtzaapABEBAAG0H0xhdW5jaHBhZCBQUEEgZm9y
 
360
        IFdpbGxpYW0gR3JhbnSIRgQQEQIABgUCSXOMJAAKCRABz5LwpyR9xeXXAJ97VdeI3lLDvyM9
 
361
        TLeb48Ylj8dWdQCfcOJDRGfjRu9PI2+ekIoV8TqaC0GItgQTAQIAIAUCSXMxaQIbAwYLCQgH
 
362
        AwIEFQIIAwQWAgMBAh4BAheAAAoJECp86x2KYmtCEBED/0aRhr7wKmA/nyX2rUN/1dpyYT2T
 
363
        khxJT0F7l91/PGRkLUdvcX81ceRcYeiiR1x8N1tL7pwrTWZwaQ/HTHF19ZAXjptnn8zaLKUc
 
364
        VwhOrUdFE2FzNo42BWpXQAuJuBCG3DeIXDDuPRvtL+sx7h8PD/DlE5RsTaztkkbWdpkMtJp9
 
365
        =5ocD
 
366
        -----END PGP PUBLIC KEY BLOCK-----
 
367
        -----BEGIN PGP PUBLIC KEY BLOCK-----
 
368
        Version: GnuPG v1.4.9 (GNU/Linux)
 
369
 
 
370
        mQGiBEFEnz8RBAC7LstGsKD7McXZgd58oN68KquARLBl6rjA2vdhwl77KkPPOr3O
 
371
        YeSBH/voUsqausJfDNuTNivOfwceDe50lbhq52ODj4Mx9Jg+4aHn9fmRkIk41i2J
 
372
        3hZiIGPACY/FsSlRq1AhBH2wZG1lQ45W/p77AeARRehYKJP9HY+1h/uihwCgrVE2
 
373
        VzACJLuZWHbDsPoJaNQjiFcEAKbUF1rMyjd1xJM7bZeXbs8c+ohUo/ywSI/OIr8n
 
374
        <SNIP>
 
375
        RwIbDAAKCRBAl26vQ30FtdxYAJsFjU+xbex7gevyGQ2/mhqidES4MwCggqQyo+w1
 
376
        Twx6DKLF+3rF5nf1F3Q=
 
377
        =PBAe
 
378
        -----END PGP PUBLIC KEY BLOCK-----
 
379
        '''
352
380
 
353
381
 
354
382
[user_info]