瀏覽代碼

- renaming scripts part 1

git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@4571 689a6050-402a-0410-94f2-e92a70836424
Klaus Darilion 17 年之前
父節點
當前提交
f1b182490c
共有 3 個文件被更改,包括 52 次插入52 次删除
  1. 26 26
      modules/db_berkeley/km_README
  2. 2 2
      modules/db_berkeley/km_bdb_lib.c
  3. 24 24
      modules/db_berkeley/km_doc/db_berkeley_admin.xml

+ 26 - 26
modules/db_berkeley/km_README

@@ -41,7 +41,7 @@ Will Quan
         1.9. METADATA_KEYS (required)
         1.9. METADATA_KEYS (required)
         1.10. METADATA_READONLY (optional)
         1.10. METADATA_READONLY (optional)
         1.11. METADATA_LOGFLAGS (optional)
         1.11. METADATA_LOGFLAGS (optional)
-        1.12. DB Maintaince Script : openserdbctl
+        1.12. DB Maintaince Script : kamdbctl
         1.13. DB Recovery : bdb_recover
         1.13. DB Recovery : bdb_recover
         1.14. Known Limitations
         1.14. Known Limitations
 
 
@@ -55,7 +55,7 @@ Will Quan
    1.6. METADATA_COLUMNS
    1.6. METADATA_COLUMNS
    1.7. METADATA_KEYS
    1.7. METADATA_KEYS
    1.8. METADATA_LOGFLAGS
    1.8. METADATA_LOGFLAGS
-   1.9. openserdbctl
+   1.9. kamdbctl
    1.10. bdb_recover usage
    1.10. bdb_recover usage
 
 
 Chapter 1. Admin Guide
 Chapter 1. Admin Guide
@@ -147,7 +147,7 @@ modparam("db_berkeley", "journal_roll_interval", 3600)
    Parameters: tablename (or db_path); to reload a particular
    Parameters: tablename (or db_path); to reload a particular
    table provide the tablename as the arguement (eg subscriber);
    table provide the tablename as the arguement (eg subscriber);
    to reload all tables provide the db_path to the db files. The
    to reload all tables provide the db_path to the db files. The
-   path can be found in openserctlrc DB_PATH variable.
+   path can be found in kamctlrc DB_PATH variable.
 
 
 1.6. Installation and Running
 1.6. Installation and Running
 
 
@@ -175,18 +175,18 @@ modparam("db_berkeley", "journal_roll_interval", 3600)
    install as root user of the main directory. This will install
    install as root user of the main directory. This will install
    the binaries in /usr/local/sbin/. If this was successful,
    the binaries in /usr/local/sbin/. If this was successful,
    openser control engine files should now be installed as
    openser control engine files should now be installed as
-   /usr/local/sbin/openserdbctl.
+   /usr/local/sbin/kamdbctl.
 
 
    Decide where (on the filesystem) you want to install the
    Decide where (on the filesystem) you want to install the
    Berkeley DB files. For instance,
    Berkeley DB files. For instance,
    '/usr/local/etc/openser/db_berkeley' directory. Make note of
    '/usr/local/etc/openser/db_berkeley' directory. Make note of
-   this directory as we need to add this path to the openserctlrc
+   this directory as we need to add this path to the kamctlrc
    file. Note: OpenSER will not startup without these DB files.
    file. Note: OpenSER will not startup without these DB files.
 
 
-   Edit openserctlrc - There are two parameters in this file that
+   Edit kamctlrc - There are two parameters in this file that
    should be configured before openserctrdb script can work
    should be configured before openserctrdb script can work
    properly: DBENGINE and DB_PATH. Edit file:
    properly: DBENGINE and DB_PATH. Edit file:
-   '/usr/local/etc/openser/openserctlrc'
+   '/usr/local/etc/openser/kamctlrc'
                 ## database type: MYSQL, PGSQL, DB_BERKELEY, or DBTEXT,
                 ## database type: MYSQL, PGSQL, DB_BERKELEY, or DBTEXT,
 by default none is loaded
 by default none is loaded
                 # DBENGINE=DB_BERKELEY
                 # DBENGINE=DB_BERKELEY
@@ -209,11 +209,11 @@ by default none is loaded
                 METADATA_LOGFLAGS
                 METADATA_LOGFLAGS
                 0
                 0
 
 
-   Execute openserdbctl - There are three (3) groups of tables you
+   Execute kamdbctl - There are three (3) groups of tables you
    may need depending on your situation.
    may need depending on your situation.
-                openserdbctl create             (required)
-                openserdbctl presence           (optional)
-                openserdbctl extra              (optional)
+                kamdbctl create             (required)
+                kamdbctl presence           (optional)
+                kamdbctl extra              (optional)
 
 
    Modify the OpenSER configuration file to use db_berkeley
    Modify the OpenSER configuration file to use db_berkeley
    module. The database URL for modules must be the path to the
    module. The database URL for modules must be the path to the
@@ -248,7 +248,7 @@ by default none is loaded
 
 
 1.7. Database Schema and Metadata
 1.7. Database Schema and Metadata
 
 
-   All Berkeley DB tables are created via the openserdbctl script.
+   All Berkeley DB tables are created via the kamdbctl script.
    This section provides details as to the content and format of
    This section provides details as to the content and format of
    the DB file upon creation.
    the DB file upon creation.
 
 
@@ -396,28 +396,28 @@ r) last_name(str) email_address(str) datetime_created(datetime) timezone
    and syslog the value should be set to 1+16=17. Or if you do not
    and syslog the value should be set to 1+16=17. Or if you do not
    want to journal at all, set this to 0.
    want to journal at all, set this to 0.
 
 
-1.12. DB Maintaince Script : openserdbctl
+1.12. DB Maintaince Script : kamdbctl
 
 
-   Use the openserdbctl script for maintaining OpenSER Berkeley DB
+   Use the kamdbctl script for maintaining OpenSER Berkeley DB
    tables. This script assumes you have DBENGINE and DB_PATH setup
    tables. This script assumes you have DBENGINE and DB_PATH setup
-   correctly in openserctlrc. Note Unsupported commands are-
+   correctly in kamctlrc. Note Unsupported commands are-
    backup, restore, migrate, copy, serweb.
    backup, restore, migrate, copy, serweb.
 
 
-   Example 1.9. openserdbctl
-usage: openserdbctl create
-       openserdbctl presence
-       openserdbctl extra
-       openserdbctl drop
-       openserdbctl reinit
-       openserdbctl bdb list         (lists the underlying db files in D
+   Example 1.9. kamdbctl
+usage: kamdbctl create
+       kamdbctl presence
+       kamdbctl extra
+       kamdbctl drop
+       kamdbctl reinit
+       kamdbctl bdb list         (lists the underlying db files in D
 B_PATH)
 B_PATH)
-       openserdbctl bdb cat       db (prints the contents of db file to
+       kamdbctl bdb cat       db (prints the contents of db file to
 STDOUT in plain-text)
 STDOUT in plain-text)
-       openserdbctl bdb swap      db (installs db.new by db -> db.old; d
+       kamdbctl bdb swap      db (installs db.new by db -> db.old; d
 b.new -> db)
 b.new -> db)
-       openserdbctl bdb append    db datafile (appends data to a new ins
+       kamdbctl bdb append    db datafile (appends data to a new ins
 tance of db; output DB_PATH/db.new)
 tance of db; output DB_PATH/db.new)
-       openserdbctl bdb newappend db datafile (appends data to a new ins
+       kamdbctl bdb newappend db datafile (appends data to a new ins
 tance of db; output DB_PATH/db.new)
 tance of db; output DB_PATH/db.new)
 
 
 1.13. DB Recovery : bdb_recover
 1.13. DB Recovery : bdb_recover

+ 2 - 2
modules/db_berkeley/km_bdb_lib.c

@@ -550,11 +550,11 @@ void bdblib_log(int op, table_p _tp, char* _msg, int len)
  * files (db) that we require.
  * files (db) that we require.
  * 
  * 
  * There is one db file per openser table (eg. acc), and they should exist
  * There is one db file per openser table (eg. acc), and they should exist
- * in your DB_PATH (refer to openserctlrc) directory.
+ * in your DB_PATH (refer to kamctlrc) directory.
  *
  *
  * This function does _not_ create the underlying binary db tables.
  * This function does _not_ create the underlying binary db tables.
  * Creating the tables MUST be manually performed before 
  * Creating the tables MUST be manually performed before 
- * openser startup by 'openserdbctl create'
+ * openser startup by 'kamdbctl create'
  *
  *
  * Function returns NULL on error, which will cause openser to exit.
  * Function returns NULL on error, which will cause openser to exit.
  *
  *

+ 24 - 24
modules/db_berkeley/km_doc/db_berkeley_admin.xml

@@ -145,7 +145,7 @@ modparam("db_berkeley", "journal_roll_interval", 3600)
 		
 		
 		<para>Parameters: <emphasis>tablename (or db_path); to reload a particular table 
 		<para>Parameters: <emphasis>tablename (or db_path); to reload a particular table 
 		provide the tablename as the arguement (eg subscriber); to reload all tables provide the db_path to
 		provide the tablename as the arguement (eg subscriber); to reload all tables provide the db_path to
-		the db files. The path can be found in openserctlrc DB_PATH variable. 
+		the db files. The path can be found in kamctlrc DB_PATH variable. 
 		</emphasis></para>
 		</emphasis></para>
 	</section>
 	</section>
 	</section>
 	</section>
@@ -192,20 +192,20 @@ modparam("db_berkeley", "journal_roll_interval", 3600)
 		as root user of the main directory. This will install the binaries 
 		as root user of the main directory. This will install the binaries 
 		in /usr/local/sbin/.
 		in /usr/local/sbin/.
 		If this was successful, openser control engine files should now 
 		If this was successful, openser control engine files should now 
-		be installed as /usr/local/sbin/openserdbctl.
+		be installed as /usr/local/sbin/kamdbctl.
 		</para>
 		</para>
 		
 		
 		<para>
 		<para>
 		Decide where (on the filesystem) you want to install the Berkeley DB files.
 		Decide where (on the filesystem) you want to install the Berkeley DB files.
 		For instance, '/usr/local/etc/openser/db_berkeley' directory.
 		For instance, '/usr/local/etc/openser/db_berkeley' directory.
-		Make note of this directory as we need to add this path to the openserctlrc file.
+		Make note of this directory as we need to add this path to the kamctlrc file.
 		Note: OpenSER will not startup without these DB files.
 		Note: OpenSER will not startup without these DB files.
 		</para>
 		</para>
 		
 		
 		<para>
 		<para>
-		Edit openserctlrc - There are two parameters in this file that should be 
+		Edit kamctlrc - There are two parameters in this file that should be 
 		configured before openserctrdb script can work properly: DBENGINE and DB_PATH.
 		configured before openserctrdb script can work properly: DBENGINE and DB_PATH.
-		Edit file: '/usr/local/etc/openser/openserctlrc'
+		Edit file: '/usr/local/etc/openser/kamctlrc'
 		</para>
 		</para>
 	        <programlisting  format="linespecific">
 	        <programlisting  format="linespecific">
 		## database type: MYSQL, PGSQL, DB_BERKELEY, or DBTEXT, by default none is loaded
 		## database type: MYSQL, PGSQL, DB_BERKELEY, or DBTEXT, by default none is loaded
@@ -234,13 +234,13 @@ modparam("db_berkeley", "journal_roll_interval", 3600)
 		
 		
 		
 		
 		<para>
 		<para>
-		Execute openserdbctl - There are three (3) groups of tables you may need depending
+		Execute kamdbctl - There are three (3) groups of tables you may need depending
 		on your situation.
 		on your situation.
 		</para>
 		</para>
 	        <programlisting  format="linespecific">
 	        <programlisting  format="linespecific">
-		openserdbctl create   		(required)
-		openserdbctl presence 		(optional)
-		openserdbctl extra    		(optional)
+		kamdbctl create   		(required)
+		kamdbctl presence 		(optional)
+		kamdbctl extra    		(optional)
 		</programlisting>
 		</programlisting>
 		
 		
 		<para>
 		<para>
@@ -284,7 +284,7 @@ modparam("db_berkeley", "journal_roll_interval", 3600)
 	<title>Database Schema and Metadata</title>
 	<title>Database Schema and Metadata</title>
 	
 	
 	<para>
 	<para>
-	All Berkeley DB tables are created via the openserdbctl script. 
+	All Berkeley DB tables are created via the kamdbctl script. 
 	This section provides details as to the content and 
 	This section provides details as to the content and 
 	format of the DB file upon creation.
 	format of the DB file upon creation.
 	</para>
 	</para>
@@ -488,25 +488,25 @@ username(str) domain(str) password(str) ha1(str) ha1b(str) first_name(str) last_
 	</section>
 	</section>
 	
 	
 	<section>
 	<section>
-	<title>DB Maintaince Script : openserdbctl </title>
+	<title>DB Maintaince Script : kamdbctl </title>
 	
 	
 	<para>
 	<para>
-	Use the openserdbctl script for maintaining OpenSER Berkeley DB tables.
-	This script assumes you have DBENGINE and DB_PATH setup correctly in openserctlrc.
+	Use the kamdbctl script for maintaining OpenSER Berkeley DB tables.
+	This script assumes you have DBENGINE and DB_PATH setup correctly in kamctlrc.
 	Note Unsupported commands are- backup, restore, migrate, copy, serweb.
 	Note Unsupported commands are- backup, restore, migrate, copy, serweb.
 	<example>
 	<example>
-	<title>openserdbctl</title>
+	<title>kamdbctl</title>
 	<programlisting>
 	<programlisting>
-usage: openserdbctl create   
-       openserdbctl presence 
-       openserdbctl extra    
-       openserdbctl drop     
-       openserdbctl reinit   
-       openserdbctl bdb list         (lists the underlying db files in DB_PATH)
-       openserdbctl bdb cat       db (prints the contents of db file to STDOUT in plain-text)
-       openserdbctl bdb swap      db (installs db.new by db -> db.old; db.new -> db)
-       openserdbctl bdb append    db datafile (appends data to a new instance of db; output DB_PATH/db.new)
-       openserdbctl bdb newappend db datafile (appends data to a new instance of db; output DB_PATH/db.new)
+usage: kamdbctl create   
+       kamdbctl presence 
+       kamdbctl extra    
+       kamdbctl drop     
+       kamdbctl reinit   
+       kamdbctl bdb list         (lists the underlying db files in DB_PATH)
+       kamdbctl bdb cat       db (prints the contents of db file to STDOUT in plain-text)
+       kamdbctl bdb swap      db (installs db.new by db -> db.old; db.new -> db)
+       kamdbctl bdb append    db datafile (appends data to a new instance of db; output DB_PATH/db.new)
+       kamdbctl bdb newappend db datafile (appends data to a new instance of db; output DB_PATH/db.new)
 	</programlisting>
 	</programlisting>
 	</example>
 	</example>
 	</para>
 	</para>