Permalink
Browse files

Added VERSION file. This is needed for the configure script to determ…

…ine current svn version.

Added some words about how to make documentation to README.
Updated userguide.
Smppbox now reports proper smppbox value.
Fixed warning about some defines already defined.


git-svn-id: https://svn.kannel.org/opensmppbox/trunk@22 0b225a68-5fa7-45c5-9c9e-d7f6881f360f
  • Loading branch information...
rkluwen
rkluwen committed Jul 12, 2010
1 parent 9beaf68 commit 5f4d10e8d87f920d4becf2c03be91481160bdd58
Showing with 49 additions and 27 deletions.
  1. +3 −2 README
  2. +14 −0 VERSION
  3. +20 −23 doc/userguide.xml
  4. +12 −2 gw/smppbox.c
View
5 README
@@ -25,11 +25,12 @@ And finally, as root:
make install
-You need to have a compiled version of Kannel available in order to compile
+You need to have a development version of Kannel installed in order to compile
smppbox.
The Userguide has also valuable information about the install and configuration
-steps.
+steps. To create the userguide, run ./configure with --enable-docs and then
+type "make docs".
HELP
====
View
14 VERSION
@@ -0,0 +1,14 @@
+svn
+This file contains the version number of smppbox.
+It is stored on the first line. Nothing else should
+be there.
+
+Note that if you get this file from SVN, it will just
+say "svn-r<revision>" instead of a version number.
+This is intentional, it avoids confusion with real releases.
+
+Starting with version 0.8, version numbers that have an even
+second part are STABLE versions and those with odd ones are
+DEVELOPMENT versions. Thus, 1.0 is stable, 1.1 is development.
+Don't use development versions for production unless you
+really know what you do.
View
@@ -241,7 +241,7 @@
<para>
Latest Kannel must be installed (>1.4.3 svn version), including development
headers and libraries. Kannel's gwlib is needed for compilation.
- Additionally an working (running) Bearerbox is needed to route SMS to.
+ Additionally a working (running) Bearerbox is needed to route SMS to.
If it is not available, SMS messages can possibly be lost and no more
logins are permitted.
</para>
@@ -251,7 +251,7 @@
tool-chain is recommended)
</para>
<para>
- To build this documentation, docbook and a number of other tools are needed.
+ To build this documentation, the docbook c.s. tools are needed.
</para>
</sect1>
</chapter>
@@ -270,6 +270,7 @@
<para>
If you are upgrading from a previous version, please look at
<xref linkend="upgrading-notes"> for any important information.
+ See chapter 5.
</para>
</note>
@@ -305,9 +306,8 @@
</para>
<para>
- We intend to cover everything you need to install and use Kannel
- is in <citetitle>User's Guide</citetitle>, but the guide is still
- incomplete in this respect. The <filename>README</filename> is not
+ Everything you need to install and use SMPPBox is in <citetitle>User's Guide.</citetitle>
+ The guide is still incomplete in this respect. The <filename>README</filename> is not
supposed to be very important, nor contain much information. Instead,
it will just point to the other documentation.
</para>
@@ -318,9 +318,9 @@
<title>Compiling the proxy</title>
<para>If you are using SMPPBox on a supported platform, or one
- that is similar enough to one, compiling Kannel should be trivial.
- After you have unpacked the source package of your choose,
- or after you have checked out the source code from CVS, enter
+ that is similar enough to one, compiling Smppbox should be trivial.
+ After you have unpacked the source package of your choice,
+ or after you have checked out the source code from SVN, enter
the following commands:
<screen><userinput>
@@ -359,7 +359,7 @@
The above, for instance, seems to be required on FreeBSD. If you
want to do development, you probably want to add CFLAGS that make
- your compiler use warning messages. For example, for GCC:
+ your compiler print warning messages. For example, for GCC:
<screen><userinput>
CFLAGS='-Wall -g' ./configure
@@ -387,21 +387,21 @@
The user that runs make install needs to have write permissions
do the bindir directory. It defaults to <filename>/usr/local/sbin</filename>.
- So possibly you need to be root to be able to install.
-
+ So possibly you need to be root to be able to install.
The version number of the proxy is added to the file
during installation. This makes it easier to have several
versions installed, and makes it easy to go back to an older
version if the new version proves problematic.
</para>
<para>
- After installation, you should now be able to run the SMPPBox init.d
+ After installation, you should now be able to run the Kannel init.d
script that will start the proxy. Run the script as root.
- TODO: We don't have such a script yet.
+ For smppbox we don't have a seperate init script, but versions of the
+ Kannel init script are available that include starting smppbox.
</para>
<screen><userinput>
- /etc/init.d/smppbox start
+ /etc/init.d/kannel start
</userinput></screen>
<para>
@@ -410,7 +410,7 @@
</para>
<screen><userinput>
- /etc/init.d/smppbox stop
+ /etc/init.d/kannel stop
</userinput></screen>
<para>
@@ -420,7 +420,7 @@
</para>
<screen><userinput>
- /etc/init.d/smppbox restart
+ /etc/init.d/kannel restart
</userinput></screen>
</sect1>
</chapter>
@@ -430,20 +430,17 @@
<para>
This chapter explains how the proxy, SMPPBox, is configured and used.
- It covers the configuration file and keeping an eye on the gateway
- while it is running.
+ It covers the configuration file and proxy administration during runtime.
</para>
<para>
There is only one configuration file for all parts of SMPPBox. If
several proxy instances are distributed among different hosts, each one
needs to have its own configuration file, with its own options.
</para>
<para>
- In the status page of bearerbox, you can see all the clients that are
- currently connected to smppbox. They all appear as seperate "smsbox"
- in the status page. Note that the ip address that is listed on the status
- page of bearerbox is the one of smppbox; not the client ip address of the
- smppbox user.
+ In bearerbox's status page you can see all connected smppbox clients as different smsboxes.
+ Note that the ip address that is listed on the status page of bearerbox is the one of smppbox;
+ not the client ip address of the smppbox user.
</para>
<sect1>
View
@@ -79,6 +79,10 @@
#include "gw/heartbeat.h"
#include "gw/meta_data.h"
+#undef GW_NAME
+#undef GW_VERSION
+#include "../sb-config.h"
+
/* our config */
static Cfg *cfg;
/* have we received restart cmd from bearerbox? */
@@ -1943,6 +1947,10 @@ static int smppbox_is_allowed_in_group(Octstr *group, Octstr *variable)
return 0;
}
+#undef OCTSTR
+#undef SINGLE_GROUP
+#undef MULTI_GROUP
+
static int smppbox_is_single_group(Octstr *query)
{
#define OCTSTR(name)
@@ -1959,7 +1967,7 @@ static int smppbox_is_single_group(Octstr *query)
int main(int argc, char **argv)
{
int cf_index;
- Octstr *filename;
+ Octstr *filename, *version;
gwlib_init();
all_boxes = gwlist_create();
@@ -1984,7 +1992,9 @@ int main(int argc, char **argv)
octstr_destroy(filename);
- report_versions("smppbox");
+ version = octstr_format("smppbox version %s", GW_VERSION);
+ report_versions(octstr_get_cstr(version));
+ octstr_destroy(version);
init_smppbox(cfg);

0 comments on commit 5f4d10e

Please sign in to comment.