Pārlūkot izejas kodu

Document logging interface

Bob Mottram 8 gadus atpakaļ
vecāks
revīzija
b42080788a
2 mainītis faili ar 45 papildinājumiem un 24 dzēšanām
  1. 10
    0
      doc/EN/devguide.org
  2. 35
    24
      website/EN/devguide.html

+ 10
- 0
doc/EN/devguide.org Parādīt failu

89
                      MYAPPNAME_ONION_PORT
89
                      MYAPPNAME_ONION_PORT
90
                      MYAPPNAME_DB_PASSWORD)
90
                      MYAPPNAME_DB_PASSWORD)
91
 
91
 
92
+function logging_on_xmpp {
93
+    echo -n ''
94
+    # Commands to turn on logging go here
95
+}
96
+
97
+function logging_off_xmpp {
98
+    echo -n ''
99
+    # Commands to turn off logging go here
100
+}
101
+
92
 function change_password_myappname {
102
 function change_password_myappname {
93
     PASSWORD_USERNAME="$1"
103
     PASSWORD_USERNAME="$1"
94
     PASSWORD_NEW="$2"
104
     PASSWORD_NEW="$2"

+ 35
- 24
website/EN/devguide.html Parādīt failu

3
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
4
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5
 <head>
5
 <head>
6
-<!-- 2016-11-23 Wed 23:19 -->
6
+<!-- 2017-07-01 Sat 20:23 -->
7
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
7
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
8
 <meta name="viewport" content="width=device-width, initial-scale=1" />
8
 <meta name="viewport" content="width=device-width, initial-scale=1" />
9
 <title></title>
9
 <title></title>
71
   pre.src-fortran:before { content: 'Fortran'; }
71
   pre.src-fortran:before { content: 'Fortran'; }
72
   pre.src-gnuplot:before { content: 'gnuplot'; }
72
   pre.src-gnuplot:before { content: 'gnuplot'; }
73
   pre.src-haskell:before { content: 'Haskell'; }
73
   pre.src-haskell:before { content: 'Haskell'; }
74
+  pre.src-hledger:before { content: 'hledger'; }
74
   pre.src-java:before { content: 'Java'; }
75
   pre.src-java:before { content: 'Java'; }
75
   pre.src-js:before { content: 'Javascript'; }
76
   pre.src-js:before { content: 'Javascript'; }
76
   pre.src-latex:before { content: 'LaTeX'; }
77
   pre.src-latex:before { content: 'LaTeX'; }
188
 @licstart  The following is the entire license notice for the
189
 @licstart  The following is the entire license notice for the
189
 JavaScript code in this tag.
190
 JavaScript code in this tag.
190
 
191
 
191
-Copyright (C) 2012-2013 Free Software Foundation, Inc.
192
+Copyright (C) 2012-2017 Free Software Foundation, Inc.
192
 
193
 
193
 The JavaScript code in this tag is free software: you can
194
 The JavaScript code in this tag is free software: you can
194
 redistribute it and/or modify it under the terms of the GNU
195
 redistribute it and/or modify it under the terms of the GNU
245
 
246
 
246
 <center><h1>Developers Guide</h1></center>
247
 <center><h1>Developers Guide</h1></center>
247
 
248
 
248
-<div id="outline-container-org1fc2c1f" class="outline-2">
249
-<h2 id="org1fc2c1f">Introduction</h2>
250
-<div class="outline-text-2" id="text-org1fc2c1f">
249
+<div id="outline-container-orge96e638" class="outline-2">
250
+<h2 id="orge96e638">Introduction</h2>
251
+<div class="outline-text-2" id="text-orge96e638">
251
 <p>
252
 <p>
252
 Freedombone consists of a set of bash scripts. There are a lot of them, but they're not very complicated. If you're familiar with the GNU/Linux commandline and can hack a bash script then you can probably add a new app or fix a bug in the system. There are no trendy development frameworks to learn or to get in your way.
253
 Freedombone consists of a set of bash scripts. There are a lot of them, but they're not very complicated. If you're familiar with the GNU/Linux commandline and can hack a bash script then you can probably add a new app or fix a bug in the system. There are no trendy development frameworks to learn or to get in your way.
253
 </p>
254
 </p>
254
 </div>
255
 </div>
255
 </div>
256
 </div>
256
-<div id="outline-container-org3f49a43" class="outline-2">
257
-<h2 id="org3f49a43">Community Statement</h2>
258
-<div class="outline-text-2" id="text-org3f49a43">
257
+<div id="outline-container-orgc332597" class="outline-2">
258
+<h2 id="orgc332597">Community Statement</h2>
259
+<div class="outline-text-2" id="text-orgc332597">
259
 <p>
260
 <p>
260
 This project doesn't require you to take any special pledge of allegiance or subscribe to any guru's list of commandments. It does not care about your gender, race, national flag or political alignment. It is agnostic towards your religion or lack thereof. It doesn't give one hoot as to whether you are young or old, rich or poor, gay, trans, straight or just "other". It does not care if you like your eggs sunny side up or if you are a vegan.
261
 This project doesn't require you to take any special pledge of allegiance or subscribe to any guru's list of commandments. It does not care about your gender, race, national flag or political alignment. It is agnostic towards your religion or lack thereof. It doesn't give one hoot as to whether you are young or old, rich or poor, gay, trans, straight or just "other". It does not care if you like your eggs sunny side up or if you are a vegan.
261
 </p>
262
 </p>
273
 </p>
274
 </p>
274
 </div>
275
 </div>
275
 </div>
276
 </div>
276
-<div id="outline-container-orgd57ea28" class="outline-2">
277
-<h2 id="orgd57ea28">Adding extra apps</h2>
278
-<div class="outline-text-2" id="text-orgd57ea28">
277
+<div id="outline-container-org97b40ca" class="outline-2">
278
+<h2 id="org97b40ca">Adding extra apps</h2>
279
+<div class="outline-text-2" id="text-org97b40ca">
279
 <p>
280
 <p>
280
 Suppose you have some internet application which you want to add to the system. To do this you need to create an app script which tells the system how to install/remove and also backup/restore. The script should be designed to work with the current stable version of Debian.
281
 Suppose you have some internet application which you want to add to the system. To do this you need to create an app script which tells the system how to install/remove and also backup/restore. The script should be designed to work with the current stable version of Debian.
281
 </p>
282
 </p>
285
 </p>
286
 </p>
286
 
287
 
287
 <div class="org-src-container">
288
 <div class="org-src-container">
288
-<pre class="src src-bash">/usr/share/freedombone/apps
289
-</pre>
289
+<pre><code class="src src-bash">/usr/share/freedombone/apps
290
+</code></pre>
290
 </div>
291
 </div>
291
 
292
 
292
 <p>
293
 <p>
294
 </p>
295
 </p>
295
 
296
 
296
 <div class="org-src-container">
297
 <div class="org-src-container">
297
-<pre class="src src-bash">freedombone-app-[myappname]
298
-</pre>
298
+<pre><code class="src src-bash">freedombone-app-[myappname]
299
+</code></pre>
299
 </div>
300
 </div>
300
 
301
 
301
 <p>
302
 <p>
307
 </p>
308
 </p>
308
 
309
 
309
 <div class="org-src-container">
310
 <div class="org-src-container">
310
-<pre class="src src-bash"><span class="org-comment-delimiter">#</span><span class="org-comment">!/bin/</span><span class="org-keyword">bash</span>
311
+<pre><code class="src src-bash"><span class="org-comment-delimiter">#</span><span class="org-comment">!/bin/</span><span class="org-keyword">bash</span>
311
 <span class="org-comment-delimiter"># </span><span class="org-comment">Copyright (C) Year YourName &lt;YourEmail&gt;</span>
312
 <span class="org-comment-delimiter"># </span><span class="org-comment">Copyright (C) Year YourName &lt;YourEmail&gt;</span>
312
 <span class="org-comment-delimiter">#</span>
313
 <span class="org-comment-delimiter">#</span>
313
 <span class="org-comment-delimiter"># </span><span class="org-comment">This program is free software: you can redistribute it</span>
314
 <span class="org-comment-delimiter"># </span><span class="org-comment">This program is free software: you can redistribute it</span>
352
                      MYAPPNAME_ONION_PORT
353
                      MYAPPNAME_ONION_PORT
353
                      MYAPPNAME_DB_PASSWORD)
354
                      MYAPPNAME_DB_PASSWORD)
354
 
355
 
356
+<span class="org-keyword">function</span> <span class="org-function-name">logging_on_xmpp</span> {
357
+    <span class="org-builtin">echo</span> -n <span class="org-string">''</span>
358
+    <span class="org-comment-delimiter"># </span><span class="org-comment">Commands to turn on logging go here</span>
359
+}
360
+
361
+<span class="org-keyword">function</span> <span class="org-function-name">logging_off_xmpp</span> {
362
+    <span class="org-builtin">echo</span> -n <span class="org-string">''</span>
363
+    <span class="org-comment-delimiter"># </span><span class="org-comment">Commands to turn off logging go here</span>
364
+}
365
+
355
 <span class="org-keyword">function</span> <span class="org-function-name">change_password_myappname</span> {
366
 <span class="org-keyword">function</span> <span class="org-function-name">change_password_myappname</span> {
356
     <span class="org-variable-name">PASSWORD_USERNAME</span>=<span class="org-string">"$1"</span>
367
     <span class="org-variable-name">PASSWORD_USERNAME</span>=<span class="org-string">"$1"</span>
357
     <span class="org-variable-name">PASSWORD_NEW</span>=<span class="org-string">"$2"</span>
368
     <span class="org-variable-name">PASSWORD_NEW</span>=<span class="org-string">"$2"</span>
508
 }
519
 }
509
 
520
 
510
 <span class="org-comment-delimiter"># </span><span class="org-comment">NOTE: deliberately no exit 0</span>
521
 <span class="org-comment-delimiter"># </span><span class="org-comment">NOTE: deliberately no exit 0</span>
511
-</pre>
522
+</code></pre>
512
 </div>
523
 </div>
513
 
524
 
514
 <p>
525
 <p>
516
 </p>
527
 </p>
517
 
528
 
518
 <div class="org-src-container">
529
 <div class="org-src-container">
519
-<pre class="src src-bash">sudo su
520
-</pre>
530
+<pre><code class="src src-bash">sudo su
531
+</code></pre>
521
 </div>
532
 </div>
522
 
533
 
523
 <p>
534
 <p>
529
 </p>
540
 </p>
530
 
541
 
531
 <div class="org-src-container">
542
 <div class="org-src-container">
532
-<pre class="src src-bash">control
533
-</pre>
543
+<pre><code class="src src-bash">control
544
+</code></pre>
534
 </div>
545
 </div>
535
 
546
 
536
 <p>
547
 <p>
543
 </div>
554
 </div>
544
 </div>
555
 </div>
545
 
556
 
546
-<div id="outline-container-orgf5d4a43" class="outline-2">
547
-<h2 id="orgf5d4a43">Customising mesh images</h2>
548
-<div class="outline-text-2" id="text-orgf5d4a43">
557
+<div id="outline-container-org285c2d1" class="outline-2">
558
+<h2 id="org285c2d1">Customising mesh images</h2>
559
+<div class="outline-text-2" id="text-org285c2d1">
549
 <p>
560
 <p>
550
 If you want to make your own specially branded version of the mesh images, such as for a particular event, then to change the default desktop backgrounds edit the images within <b>img/backgrounds</b> and to change the available avatars and desktop icons edit the images within <b>img/avatars</b>. Re-create disk images using the instructions shown previously.
561
 If you want to make your own specially branded version of the mesh images, such as for a particular event, then to change the default desktop backgrounds edit the images within <b>img/backgrounds</b> and to change the available avatars and desktop icons edit the images within <b>img/avatars</b>. Re-create disk images using the instructions shown previously.
551
 </p>
562
 </p>