README

   1
   2 This is Moonlight, an open source implementation of Silverlight 1.0
   3 and 2.0 for Unix systems.
   4
   5 See http://www.mono-project.com/Moonlight for more information.
   6
   7 Installation
   8 ============
   9
  10         For installation instructions, see the INSTALL file
  11
  12 Runtime Options
  13 ===============
  14
  15         There is a couple of runtime-parameters that affect Moonlight behavior
  16         and turn on/off certain features. Those options are specified through
  17         the MOONLIGHT_OVERRIDES env variable. The more interesting ones are:
  18
  19         * shapecache=yes/no
  20
  21                 Use some extra memory for caching shapes.  Increases
  22                 memory usage but helps with performance (off by
  23                 default). The shape cache size is 6MB max.
  24
  25         * render=ftb/btf
  26
  27                 Use front-to-back or back-to-front rendering (ftb is
  28                 the default).
  29
  30         * cache=show/hide
  31
  32                 Show the (shape) cache usage statistics. In plugin
  33                 mode they're available through the right-click popup
  34                 menu (hide by default).
  35
  36         * converter=yuv/ffmpeg
  37
  38                 Use native mmx/sse2 conversion code or ffmpeg to do
  39                 the yuv -> rgb colorspace conversion (by default we
  40                 use the native yuv code).
  41
  42         To launch Firefox with shape caching and ffmpeg converters use:
  43
  44                 $> MOONLIGHT_OVERRIDES="shapecache=yes,converter=ffmpeg" firefox
  45
  46
  47         Other options include:
  48
  49         * ms-codecs=yes/no
  50         * ffmpeg-codecs=yes/no
  51
  52                 Controls which sets of codecs to use, the Microsoft
  53                 ones or the ffmpeg ones.
  54
  55         * timesource=manual/system
  56
  57                 Defaults to `system'.
  58
  59
  60         Also if --with-debug=yes option was provided to configure script, the
  61         MOONLIGHT_DEBUG env variable controls which debug output is printed
  62         on the console. Valid values are:
  63
  64                 alsa, alsa-ex, audio, audio-ex, pulse, pulse-ex, httpstreaming,
  65                 markers, markers-ex, mms, mediaplayer, mediaplayer-ex, pipeline,
  66                 pipeline-error, framereaderloop, ui, ffmpeg, codecs, dependencyobject,
  67                 downloader, font, layout, media, mediaelement, mediaelement-ex,
  68                 buffering, asf, playlist, playlist-warn, text, xaml
  69
  70
  71 Licensing
  72 =========
  73
  74         The C and C++ code that makes up the engine is dual-licensed
  75         under the LGPL v2 license and is also available commercially
  76         for developers interested in using Moonlight on embedded
  77         systems or other systems where the end-user can not upgrade
  78         the LGPL code on his own.
  79
  80         The C# tests in test/2.0/Microsoft.Silverlight.Testing are
  81         copyrighted by Microsoft and released by them under the
  82         open source MS-PL license.
  83
  84         The C# controls in class/Microsoft.SilverlightControls/ and
  85         class/WPF.Toolkit are copyrighted by Microsoft and released by
  86         them under the open source MS-PL license.
  87
  88 Technical Details
  89 =================
  90
  91         For implementation details and notes, see the NOTES file.
  92
  93
  94 Test Suite
  95 ==========
  96
  97         To run the test suite, make sure that the output from
  98         configure indicates that the tests will be run.  Once this is
  99         done, you can run the tests like this:
 100
 101         To run the Novell tests:
 102
 103                 cd moon/tests
 104                 ./make-xephyr run-tests
 105
 106         To run the Microsoft tests (you need the moonlight-ms module
 107         as a peer of moon):
 108
 109                 cd moon/test
 110                 ./make-xephyr run-ms-tests
 111
 112         To run the Moonlight Unit Tests:
 113
 114                 cd moon/test/2.0/moon-unit
 115                 make test
 116
 117
 118 Firefox 3
 119 =========
 120
 121         The original Silverlight.js shipped by Microsoft was incompatible
 122         with Firefox 3.  We have released a greasemonkey script
 123         (data/silverlight-ff3-quirks.user.js) that will patch this behaviour
 124         for some sites.
 125
 126