summaryrefslogtreecommitdiff
path: root/docs
authorkergoth <kergoth>2002-01-28 23:28:04 (UTC)
committer kergoth <kergoth>2002-01-28 23:28:04 (UTC)
commitf7b3193e5d2d9a211ce0b963dca571d82adecb71 (patch) (unidiff)
tree44f49bdc076dc299bba1a4dc8d5d517114be5701 /docs
parent77d110d35f75d63f5dc66c1dd2427daf7dc2e214 (diff)
downloadopie-f7b3193e5d2d9a211ce0b963dca571d82adecb71.zip
opie-f7b3193e5d2d9a211ce0b963dca571d82adecb71.tar.gz
opie-f7b3193e5d2d9a211ce0b963dca571d82adecb71.tar.bz2
Committing in .
Modified Files: configure mkipks addressbook/Makefile.in addressbook/addressbook.pro calc2/calc.pro calc2/binary/binary.pro calc2/simple/simple.pro calculator/Makefile.in calculator/calculator.pro cardmon/Makefile.in cardmon/cardmon.pro chess/chess.pro citytime/Makefile.in citytime/citytime.pro clock/Makefile.in clock/clock.pro datebook/Makefile.in datebook/datebook.pro dictionary/dictionary.pro doc/qcop.doc doc/start.doc embeddedkonsole/Makefile.in embeddedkonsole/embeddedkonsole.pro etc/init.d/qpe example/example.pro fifteen/Makefile.in fifteen/fifteen.pro filebrowser/Makefile.in filebrowser/filebrowser.pro freetype/freetype.pro go/Makefile.in go/go.pro helpbrowser/Makefile.in helpbrowser/helpbrowser.pro inputmethods/handwriting/Makefile.in inputmethods/handwriting/handwriting.pro inputmethods/keyboard/Makefile.in inputmethods/keyboard/keyboard.pro inputmethods/pickboard/Makefile.in inputmethods/pickboard/pickboard.pro inputmethods/unikeyboard/Makefile.in inputmethods/unikeyboard/unikeyboard.pro keypebble/Makefile.in keypebble/keypebble.pro library/Makefile.in library/global.cpp library/library.pro library/qpeapplication.cpp mindbreaker/Makefile.in mindbreaker/mindbreaker.pro minesweep/Makefile.in minesweep/minesweep.pro mpegplayer/Makefile.in mpegplayer/mpegplayer.pro mpegplayer/libflash/libflash.pro mpegplayer/libmad/Makefile.in mpegplayer/libmad/libmad.pro mpegplayer/libmpeg3/Makefile.in mpegplayer/libmpeg3/libmpeg3.pro mpegplayer/libmpeg3/audio/Makefile mpegplayer/libmpeg3/video/Makefile mpegplayer/wavplugin/Makefile.in mpegplayer/wavplugin/wavplugin.pro netsetup/Makefile.in netsetup/README netsetup/netsetup.pro netsetup/dialup/Makefile.in netsetup/dialup/dialup.pro netsetup/lan/Makefile.in netsetup/lan/lan.pro parashoot/Makefile.in parashoot/parashoot.pro qasteroids/Makefile.in qasteroids/qasteroids.pro qcop/Makefile.in qcop/qcop.pro qipkg/Makefile.in qipkg/qipkg.pro scripts/q_functions settings/appearance/Makefile.in settings/appearance/appearance.pro settings/language/Makefile.in settings/language/language.pro settings/light-and-power/Makefile.in settings/light-and-power/light-and-power.pro settings/rotation/Makefile.in settings/rotation/rotation.pro settings/security/Makefile.in settings/security/security.pro settings/sound/Makefile.in settings/sound/sound.pro settings/systemtime/Makefile.in settings/systemtime/systemtime.pro showimg/Makefile.in showimg/showimg.pro single/Makefile.in single/single.pro snake/Makefile.in snake/snake.pro solitaire/Makefile.in solitaire/solitaire.pro spreadsheet/Makefile.in spreadsheet/spreadsheet.pro sysinfo/Makefile.in sysinfo/sysinfo.pro tableviewer/tableviewer.pro taskbar/Makefile.in taskbar/main.cpp taskbar/taskbar.pro taskbar/batteryapplet/Makefile.in taskbar/batteryapplet/batteryapplet.pro taskbar/clipboardapplet/clipboardapplet.pro taskbar/clockapplet/Makefile.in taskbar/clockapplet/clockapplet.pro taskbar/netmonapplet/Makefile.in taskbar/netmonapplet/netmonapplet.pro taskbar/volumeapplet/Makefile.in taskbar/volumeapplet/volumeapplet.pro tetrix/Makefile.in tetrix/tetrix.pro textedit/Makefile.in textedit/textedit.pro todo/Makefile.in todo/todo.pro tux/Makefile.in tux/tux.pro website/htdocs/build.html website/htdocs/development.html website/htdocs/refman/qcop.html website/htdocs/refman/qpeapplication.html wordgame/Makefile.in wordgame/wordgame.pro Log Message: Changed QPEDIR to OPIEDIR in .pro files, and documentation, and regenerated all Makefile.in's that were affected.
Diffstat (limited to 'docs') (more/less context) (ignore whitespace changes)
-rw-r--r--docs/qcop.doc2
-rw-r--r--docs/start.doc12
2 files changed, 7 insertions, 7 deletions
diff --git a/docs/qcop.doc b/docs/qcop.doc
index 6fe4c71..e62f91d 100644
--- a/docs/qcop.doc
+++ b/docs/qcop.doc
@@ -146,34 +146,34 @@ this channel are:
146 <li>raise() 146 <li>raise()
147 <br>Internal. Causes the the main document widget and the 147 <br>Internal. Causes the the main document widget and the
148 current modal widget to be raised. 148 current modal widget to be raised.
149 <li>quit() 149 <li>quit()
150 <br>Internal. Terminates the application. 150 <br>Internal. Terminates the application.
151 <li>quitIfInvisible() 151 <li>quitIfInvisible()
152 <br>Internal. Terminates the application if it is not shown. 152 <br>Internal. Terminates the application if it is not shown.
153 </ul> 153 </ul>
154</dl> 154</dl>
155 155
156The QPE/Application/<i>appname</i> channel has a special property: when 156The QPE/Application/<i>appname</i> channel has a special property: when
157messages are sent to these channels vie QCopEnvelope, the message is 157messages are sent to these channels vie QCopEnvelope, the message is
158delivered even if the application is not yet running (the application 158delivered even if the application is not yet running (the application
159is run and the message is then sent). 159is run and the message is then sent).
160 160
161Applications also respond to messages specific to the application. 161Applications also respond to messages specific to the application.
162Such messages in the base Qtopia applications are: 162Such messages in the base Qtopia applications are:
163 163
164<dl> 164<dl>
165 <dt><b>QPE/Application/helpbrowser</b> 165 <dt><b>QPE/Application/helpbrowser</b>
166 <ul> 166 <ul>
167 <li>showFile(QString <i>file</i>) 167 <li>showFile(QString <i>file</i>)
168 <br>Send this message to have the Help Browser show a file. 168 <br>Send this message to have the Help Browser show a file.
169 The <i>file</i> may be an absolute filename or relative 169 The <i>file</i> may be an absolute filename or relative
170 to the system HTML documentation directory ($QPEDIR/help/html). 170 to the system HTML documentation directory ($OPIEDIR/help/html).
171 </ul> 171 </ul>
172 <dt><b>QPE/Application/datebook</b> 172 <dt><b>QPE/Application/datebook</b>
173 <ul> 173 <ul>
174 <li>alarm(QDateTime,int) 174 <li>alarm(QDateTime,int)
175 <br>Internal. Causes the Calendar application to sound alarms. 175 <br>Internal. Causes the Calendar application to sound alarms.
176 </ul> 176 </ul>
177</dl> 177</dl>
178 178
179*/ 179*/
diff --git a/docs/start.doc b/docs/start.doc
index 9745d9a..01b6ab1 100644
--- a/docs/start.doc
+++ b/docs/start.doc
@@ -37,126 +37,126 @@ environment. It also includes cross-compiler software so that you can
37compile your application to run on the target handheld device. 37compile your application to run on the target handheld device.
38If you do not already have the Qtopia SDK (this document is normally 38If you do not already have the Qtopia SDK (this document is normally
39part of the SDK), contact info@trolltech.com, or see the 39part of the SDK), contact info@trolltech.com, or see the
40<a href=http://www.trolltech.com>Trolltech</a> web site. 40<a href=http://www.trolltech.com>Trolltech</a> web site.
41 41
42<p>To build applications for the SHARP SL5000 or similar StrongARM-based devices, 42<p>To build applications for the SHARP SL5000 or similar StrongARM-based devices,
43you will also need a StrongARM cross compiler. Entrants in the programming 43you will also need a StrongARM cross compiler. Entrants in the programming
44contest for this device will have received both the SDK and a cross-compiler. 44contest for this device will have received both the SDK and a cross-compiler.
45 45
46<p> 46<p>
47The SDK includes an example program. We recommend that you compile and 47The SDK includes an example program. We recommend that you compile and
48run this example to learn how things work, before tackling your own 48run this example to learn how things work, before tackling your own
49projects. 49projects.
50 50
51<p> 51<p>
52To compile the example program for running on the Linux desktop: 52To compile the example program for running on the Linux desktop:
53 53
54<ol> 54<ol>
55 <li> 55 <li>
56 <p> 56 <p>
57 Check the environment is correct: 57 Check the environment is correct:
58 58
59 <p> 59 <p>
60<pre> 60<pre>
61 export QPEDIR=/opt/Qtopia 61 export OPIEDIR=/opt/Qtopia
62 export QTDIR=/opt/Qtopia 62 export QTDIR=/opt/Qtopia
63 export PATH=$QTDIR/bin:$PATH 63 export PATH=$QTDIR/bin:$PATH
64 export TMAKEPATH=/opt/Qtopia/tmake/lib/qws/linux-generic-g++ 64 export TMAKEPATH=/opt/Qtopia/tmake/lib/qws/linux-generic-g++
65 export LD_LIBRARY_PATH=$QTDIR/lib:$LD_LIBRARY_PATH 65 export LD_LIBRARY_PATH=$QTDIR/lib:$LD_LIBRARY_PATH
66</pre> 66</pre>
67 67
68 <li> Take a copy of the example: 68 <li> Take a copy of the example:
69 69
70<pre> 70<pre>
71 cd somewhere 71 cd somewhere
72 cp -r $QPEDIR/example . 72 cp -r $OPIEDIR/example .
73 cd example 73 cd example
74</pre> 74</pre>
75 75
76 <li> Generate a Makefile: 76 <li> Generate a Makefile:
77 77
78<pre> 78<pre>
79 tmake -o Makefile example.pro 79 tmake -o Makefile example.pro
80</pre> 80</pre>
81 81
82 <li> Build the example: 82 <li> Build the example:
83 83
84<pre> 84<pre>
85 make 85 make
86</pre> 86</pre>
87 87
88 <li> Install it: 88 <li> Install it:
89 89
90<pre> 90<pre>
91 su # root privileges required to install 91 su # root privileges required to install
92 cp example.desktop $QPEDIR/apps/Applications 92 cp example.desktop $OPIEDIR/apps/Applications
93 cp Example.png $QPEDIR/pics 93 cp Example.png $OPIEDIR/pics
94 cp example $QPEDIR/bin 94 cp example $OPIEDIR/bin
95 exit # no need to be root anymore 95 exit # no need to be root anymore
96</pre> 96</pre>
97 97
98 <li> To run it, first run the Qt Virtual Framebuffer: 98 <li> To run it, first run the Qt Virtual Framebuffer:
99 99
100<pre> 100<pre>
101 qvfb &amp; 101 qvfb &amp;
102</pre> 102</pre>
103 103
104 <li> Then run the <i>Qtopia</i> environment: 104 <li> Then run the <i>Qtopia</i> environment:
105 105
106<pre> 106<pre>
107 qpe 107 qpe
108</pre> 108</pre>
109 109
110<p> 110<p>
111 Your application should be available in the Applications tab visible 111 Your application should be available in the Applications tab visible
112inside the Qt Virtual Framebuffer window. 112inside the Qt Virtual Framebuffer window.
113</p> 113</p>
114 114
115 <li> If you want to distribute your applications to others, build an RPM package, e.g.: 115 <li> If you want to distribute your applications to others, build an RPM package, e.g.:
116<pre> 116<pre>
117 mkipks -rpm -arch i386 example.control 117 mkipks -rpm -arch i386 example.control
118</pre> 118</pre>
119</ol> 119</ol>
120 120
121<p> 121<p>
122To make your own application, use the example program as a model. Make sure that 122To make your own application, use the example program as a model. Make sure that
123when you add files to your project, you also add them 123when you add files to your project, you also add them
124to your project file (e.g. <tt>example.pro</tt>) and rerun the 124to your project file (e.g. <tt>example.pro</tt>) and rerun the
125<tt>tmake</tt> command to update the <tt>Makefile</tt>. 125<tt>tmake</tt> command to update the <tt>Makefile</tt>.
126 126
127<p> 127<p>
128To build you application for the SHARP SL5000 rather than just running 128To build you application for the SHARP SL5000 rather than just running
129on the desktop, the process is similar: 129on the desktop, the process is similar:
130 130
131<ol> 131<ol>
132 <li> 132 <li>
133 <p> 133 <p>
134 Check the environment is correctly set for the SHARP SL5000: 134 Check the environment is correctly set for the SHARP SL5000:
135 135
136 <p> 136 <p>
137<pre> 137<pre>
138 export QPEDIR=/opt/Qtopia/sharp 138 export OPIEDIR=/opt/Qtopia/sharp
139 export QTDIR=/opt/Qtopia/sharp 139 export QTDIR=/opt/Qtopia/sharp
140 export PATH=$QTDIR/bin:/usr/local/arm/bin:$PATH 140 export PATH=$QTDIR/bin:/usr/local/arm/bin:$PATH
141 export TMAKEPATH=/opt/Qtopia/tmake/lib/qws/linux-sharp-g++ 141 export TMAKEPATH=/opt/Qtopia/tmake/lib/qws/linux-sharp-g++
142</pre> 142</pre>
143 143
144 <li> Build and install exactly the same as you did for the desktop 144 <li> Build and install exactly the same as you did for the desktop
145 (note that the generated Makefile is different): 145 (note that the generated Makefile is different):
146<pre> 146<pre>
147 make clean 147 make clean
148 tmake -o Makefile example.pro 148 tmake -o Makefile example.pro
149 ... <i>etc.</i> 149 ... <i>etc.</i>
150</pre> 150</pre>
151 151
152 <li> To install it on a device, build an ipk package file (you should be root 152 <li> To install it on a device, build an ipk package file (you should be root
153 to do this, since then it will strip the executable for you): 153 to do this, since then it will strip the executable for you):
154<pre> 154<pre>
155 mkipks example.control 155 mkipks example.control
156</pre> 156</pre>
157 157
158<p> 158<p>
159 The resulting <tt>example-1.0.0.ipk</tt> can be installed on the 159 The resulting <tt>example-1.0.0.ipk</tt> can be installed on the
160SL5000 by using <i>Qtopia Desktop</i>. 160SL5000 by using <i>Qtopia Desktop</i>.
161</p> 161</p>
162 162