Merge lp:~rodrigo-gadea-percona/percona-ganglia-mysql/docs into lp:~vadim-tk/percona-ganglia-mysql/init-repo

[Rodrigo Gadea]

Documentation update

=== modified file 'INSTALL'
--- INSTALL	2011-06-23 20:57:30 +0000
+++ INSTALL	2011-06-24 06:42:35 +0000
@@ -1,31 +1,73 @@
-Installation instructions
-
-This document assumes you have ganglia installed and
-configured and it is not covered.
-
-Pre-requirements are:
-php working in command line mode
-gmetric binary accessible ( i.e in $PATH environment variable)
-
-To start gathering statistics the script may be located
-in crontab for periodic execution.
-
-Sample crontab line:
-
-*/1 * * * * root php PATH_TO_SCRIPT/ss_get_mysql_stats.php --host 127.0.0.1 > /var/log/mysql-ganglia-2.log
-
---host is mandatory parameter and this is hostname used to connect to mysqld process
- 
-Additional parameters
-   --user      MySQL username; defaults to $mysql_user if not given
-   --pass      MySQL password; defaults to $mysql_pass if not given
-   --port      MySQL port; defaults to $mysql_port if not given
-
-And last parameter is
- --gmetric_param  Parameter to pass directly to gmetric
-
-ss_get_mysql_stats.php  calls gmetric for each metric, and sometime you may need to pass additional parameter to gmetric. For example -d 60 , which says to metric to expire in 60 seconds.
-
-Usage example:
-ss_get_mysql_stats.php --host 127.0.0.1 --gmetric_param "-d 60" 
-
+=========================
+INSTALLATION INSTRUCTIONS
+=========================
+
+NOTE: This document assumes you have Ganglia
+      installed and configured (see README).
+
+
+INSTALLATION
+============
+
+Once downloaded, configuration instructions are available online at
+
+  http://code.google.com/p/mysql-cacti-templates/wiki/InstallingTemplates#Configuring
+
+If the templates do not match your polling interval, desired graph size, or any
+number of other qualities, you can easily generate your own. Customization 
+instructions can be found at
+
+  http://code.google.com/p/mysql-cacti-templates/wiki/CustomizingTemplates
+
+
+USAGE
+=====
+
+PREREQUISITES
+-------------
+
+ - php works in command line mode 
+ - gmetric binary is accessible ( i.e through your $PATH environment variable)
+
+
+SYNOPSIS
+--------
+
+  ss_get_mysql_stats.php --host HOST
+                         [[--user USER] [--pass PASSWORD] [--port PORT]] 
+                         [--gmetric_param]
+
+
+OPTIONS
+-------
+
+  --host
+        The hostname or IP used to connect to the mysqld proccess.
+        This option is MANDATORY.
+
+  --user USER
+        MySQL username; defaults to $mysql_user if not given.
+
+  --pass PASSWORD
+        MySQL password; defaults to $mysql_pass if not given.
+
+  --port PORT
+        MySQL port; defaults to $mysql_port if not given.
+
+  --gmetric_param "STRING"
+        Additional parameters for gmetric (passed directly).
+
+
+EXAMPLES
+========
+
+To start gathering statistics, the script may be located in the crontab for 
+periodic execution. A sample crontab line would be:
+
+  */1 * * * * root php PATH_TO_SCRIPT/ss_get_mysql_stats.php --host 127.0.0.1 > /var/log/mysql-ganglia-2.log
+
+As ss_get_mysql_stats.php calls gmetric for each metric, sometimes you may need 
+to pass additional parameters to gmetric. For example -d 60 , for expiring the 
+metric in 60 seconds: 
+
+  ss_get_mysql_stats.php --host 127.0.0.1 --gmetric_param "-d 60" 
 
=== added file 'METRICS'
--- METRICS	1970-01-01 00:00:00 +0000
+++ METRICS	2011-06-24 06:42:35 +0000
@@ -0,0 +1,498 @@
+=======
+METRICS
+=======
+
+    - 'Key_read_requests'
+      The number of reads of a key block from the cache (operations per second). 
+
+    - 'Key reads'
+      The number of physical reads of a key block from disk (operations per second).
+
+    - 'Key_write_requests'
+      The number of writes of a key block to the cache (operations per second). 
+
+    - 'Key_write'
+      The number of physical writes of a key block to disk (operations per second).
+
+    - 'history_list'
+      The length of the history list shows how old the oldest unpurged transaction is (transactions).
+
+    - 'innodb_transactions'
+      The number of transactions done by the server (internal transaction counter).
+ 
+    - 'read_views'
+      The number of read views open shows how many transactions have a consistent snapshot of the database's contents, which is achieved by MVCC (transactions).
+
+    - 'current_transactions'
+      The total number of transactions currently in the server, no matter what status (ACTIVE, LOCK WAIT, not started, etc).
+
+    - 'locked_transactions'
+      The number of locked transactions in the server. Locked transactions are those in LOCK WAIT status (waiting for a row lock, a table lock or an auto-increment lock).
+
+    - 'active_transactions'
+      The number of active transactions in the server. Active transactions are those that are currently open (between BEGIN and COMMIT and also whilst a query is running).
+
+    - 'pool_size'
+      The total size of buffer pool, in pages.
+
+    - free_pages 'free_pages'
+      The number of free pages in the buffer pool.
+
+    - 'database_pages'
+      The number of used pages in the buffer pool.
+
+    - 'modified_pages' 
+      The number of modified (dirty) pages in the buffer pool.
+
+    - 'pages_read' 
+      The number of logical reads of pages that the engine could not satisfy from the buffer pool, and had to read directly from the disk (pages per second). 
+
+    - 'pages_created'
+      The number of created pages per second.
+
+    - 'pages_written'
+      The number of pages written per second.
+
+    - 'file_fsyncs'
+      The number of fsync() calls per second (operations per second).
+
+    - 'file_reads'
+      The number of file reads per second (operations per second).
+
+    - 'file_writes'
+      The amount of InnoDB's file writes per second (operations per second).
+
+    - 'log_writes'
+      The number of physical writes per second to the log file (operations per second).
+
+    - 'pending_aio_log_ios'
+     The number of total pending I/O operations to the log file (IO).
+
+    - * 'pending_aio_sync_ios'
+      The number of pending asynchronous fsync() operations in the data files (IO).
+
+    - 'pending_buf_pool_flushes'
+      The number of pending buffer pool page-flush requests (IO).
+
+    - 'pending_chkp_writes'
+      The number of pending checkpoints writes (IO).
+
+    - 'pending_ibuf_aio_reads'
+      The number of pending asynchronous Insert Buffer reads (IO).
+
+    - 'pending_log_flushes'
+      The number of pending flushes to the log file (IO).
+
+    - 'pending_log_writes'
+      The number of pending log file writes (IO).
+
+    - 'pending_normal_aio_reads'
+      The number of pending asynchronous normal reads (IO).
+
+    - 'pending_normal_aio_writes'
+      The number of pending asynchronous normal writes (IO).
+
+    - 'ibuf_inserts'
+      The number of INSERT operations per second in the InnoDB Insert Buffer.
+
+    - 'ibuf_merged' 
+      The number of MERGED RECORD operations per second in the InnoDB Insert Buffer.
+
+    - 'ibuf_merges' 
+      The number of MERGE operations per second in the InnoDB Insert Buffer.
+
+    - 'spin_waits'
+      The number of spin waits per second done by threads.
+
+    - 'spin_rounds'
+      The number of spin rounds per seconds done by threads.
+
+    - 'os_waits'
+      The number of OS waits per second done by threads.
+
+    - 'rows_inserted' 
+      The number of rows per second inserted into InnoDB tables.
+
+    - 'rows_updated' 
+      The number of rows updated per second in InnoDB tables. 
+
+    - 'rows_deleted'
+      The number of rows deleted per second from InnoDB tables.
+
+    - 'rows_read'
+      The number of rows reads per second from InnoDB tables. 
+
+    - 'Table_locks_waited'
+      The number of times per second that a request for a table lock could not be granted immediately and a wait was needed (locks per second).
+
+    - 'Table_locks_immediate'
+      The number of times per second that a request for a table lock could be granted immediately (locks per second).
+
+    - 'Slow_queries'
+      The number of queries per second that have taken more than 'long_query_time' seconds.
+
+    - 'Open_files'
+      The number of files that are open per second. This count includes regular files opened by the server. It does not include other types of files such as sockets or pipes. Also, the count does not include files that storage engines open using their own internal functions rather than asking the server level to do so. 
+      
+    - 'Open_tables'
+      The number of tables that are open per second. 
+
+    - 'Opened_tables'
+      The number of tables per second that have been opened with my_open() (a 'mysys' library function). Parts of the server that open files without using this function do not increment the count. 
+
+    - 'innodb_open_files'
+       The number of files per second that are open by InnoDB using its own internal functions rather than asking the server level to do so. 
+
+    - 'open_files_limit'
+      The number of open files that the server can have.
+
+    - 'table_cache'
+      The number of tables been cached.
+
+    - 'Aborted_clients'
+      The number of connections per second that were aborted because the client died without closing the connection properly. 
+
+    - 'Aborted_connects'
+      The number of failed attempts per second to connect to the MySQL server.
+
+    - 'Max_used_connections'
+      The maximum number of connections that have been in use simultaneously since the server started. 
+
+    - 'Slow_launch_threads'
+      The number of threads that have taken more than 'slow_launch_time' seconds to create. 
+
+    - 'Threads_cached'
+      The number of threads in the thread cache. 
+
+    - 'Threads_connected'
+      The number of currently open connections per second. 
+
+    - 'Threads_created'
+      The number of threads per second created to handle connections.
+
+    - 'Threads_running'
+      The number of threads that are not sleeping. 
+
+    - 'max_connections'
+      The number of connections permitted in the server.
+
+    - 'thread_cache_size'
+      How many threads the server should cache for reuse.
+
+    - 'Connections'
+      The number of connection attempts per second (successful or not) to the server (connections per second). 
+
+    - 'slave_running'
+      This is 1 (ON) if this server is a replication slave that is connected to a replication master, and both the I/O and SQL threads are running; otherwise, it is 0 (OFF).
+
+    - 'slave_stopped'
+      This is 1 if this server is NOT a replication slave and neither both of the I/O and SQL threads are running; otherwise, it is 0.
+
+    - 'Slave_retried_transactions'
+      The total number of times since startup that the replication slave SQL thread has retried transactions (transactions). 
+
+    - 'slave_lag' 
+      The number of seconds (estimation) of the lag between the master and the slave in a replication environment.
+
+    - 'Slave_open_temp_tables'
+      The number of temporary tables that the slave SQL thread currently has open.
+
+    - 'Qcache_free_blocks'
+      The number of free memory blocks in the query cache. 
+
+    - 'Qcache_free_memory'
+      The amount of free memory in bytes for the query cache.
+
+    - 'Qcache_hits'
+      The number of query cache hits per second. 
+
+    - 'Qcache_inserts'
+      The number of queries per second added to the query cache.
+
+    - 'Qcache_lowmem_prunes'
+      The number of queries per second that were deleted from the query cache because of low memory.
+
+    - 'Qcache_not_cached'
+      The number of non-cached queries per second (not cacheable, or not cached due to the 'query_cache_type' setting). 
+
+    - 'Qcache_queries_in_cache'
+      The number of queries per second registered in the query cache.
+
+    - 'Qcache_total_blocks'
+      The total number of blocks in the query cache. 
+
+    - 'query_cache_size'
+      The amount of memory allocated for caching query results.
+
+    - 'Questions'
+      The number of statements per second executed by the server. This includes only statements sent to the server by clients and not statements executed within stored programs, unlike the Queries variable. This variable does not count COM_PING, COM_STATISTICS, COM_STMT_PREPARE, COM_STMT_CLOSE, or COM_STMT_RESET commands (queries per second).
+
+    - 'Com_update'
+      The number of UPDATE statements per second executed (queries per second).
+
+    - 'Com_insert'
+      The number of INSERT statements per second executed (queries per second).
+
+    - 'Com_select'
+      The number of SELECT statements per second executed (queries per second).
+
+    - 'Com_delete'
+      The number of DELETE statements per second executed (queries per second).
+
+    - 'Com_replace'
+      The number of REPLACE statements per second executed (queries per second).
+
+    - 'Com_load'
+      The number of LOAD statements per second executed (queries per second).
+
+    - 'Com_update_multi'
+      The number of UPDATE statements on multiple columns (???) per second executed (queries per second).
+
+    - 'Com_insert_select'
+      The number of INSERT ... SELECT statements per second executed (queries per second).
+
+    - 'Com_delete_multi'
+      The number of DELETE statements on multiple rows (??) per second executed (queries per second).
+
+    - 'Com_replace_select'
+      The number of REPLACE ... SELECT statements per second executed (queries per second).
+
+    - 'Select_full_join'
+      The number of joins per second that perform table scans because they do not use indexes (queries per second).
+
+    - 'Select_full_range_join'
+      The number of joins per second that used a range search on a reference table (queries per second).
+      
+    - 'Select_range'
+      The number of joins per second that used ranges on the first table (queries per second).
+
+    - 'Select_range_check'
+      The number of joins without keys per second that checked for key usage after each row (queries per second).
+
+    - 'Select_scan'
+      The number of joins statements that did a full scan of the first table (queries per second). 
+
+    - 'Sort_merge_passes'
+      The number of merge passes per second that the sort algorithm has had to do (queries per second).
+
+    - 'Sort_range'
+      The number of sorts per second that were done using ranges (queries per second). 
+
+    - 'Sort_rows'
+      The number of sorted rows per second (rows per second).
+
+    - 'Sort_scan'
+      The number of sorts per second that were done by scanning the table (queries per second). 
+
+    - 'Created_tmp_tables'
+      The number of internal temporary tables per second created by the server while executing statements.
+
+    - 'Created_tmp_disk_tables'
+      The number of internal on-disk temporary tables created per second by the server while executing statements. 
+
+    - 'Created_tmp_files'
+      The number of temporary files per second that the server has created. 
+
+    - 'Bytes_sent'
+      The number of bytes per second sent to all clients. 
+
+    - 'Bytes_received'
+      The number of bytes per second received from all clients. 
+
+    - 'innodb_log_buffer_size'
+      The size in bytes of the memory buffer InnoDB uses to cache data and indexes of its tables.
+
+    - 'unflushed_log'
+      The amount in kilobytes of InnoDB logs that hasn't been flushed. 
+
+    - 'log_bytes_flushed'
+      The amount in bytes of InnoDB logs that has been flushed per second.
+
+    - 'log_bytes_written'
+      The amount in bytes of InnoDB logs that hasn't been flushed per second.
+
+    - 'relay_log_space'
+      The total combined size in bytes of all existing relay log files.
+
+    - 'binlog_cache_size'
+      The size in bytes of the cache to hold changes to the binary log during a transaction.
+
+    - 'Binlog_cache_disk_use'
+      The amount in bytes of the binary log cache in disk used by transactions: when the value of 'binlog_cache_size' is exceeded, a temporary file is used to store changes from the transaction.
+
+    - 'Binlog_cache_use'
+      The amount in bytes of the binary log cache used by transactions. 
+
+    - 'binary_log_space'
+      The total size in bytes of all existing binary log files.
+
+    - 'innodb_locked_tables'
+      The number of InnoDB tables that are locked.
+
+    - 'innodb_lock_structs'
+      The number of internal lock structures InnoDB has (locks).
+
+    - 'State_closing_tables'
+      The number of threads being in 'closing_tables' state: the thread is flushing the changed table data to disk and closing the used tables.
+
+    - 'State_copying_to_tmp_table'
+      The number of threads being in 'copying to tmp table' state: the thread is creating a temporary table in memory or on disk.
+
+    - 'State_end'
+      The number of threads being in 'end' state: this occurs at the end but before the cleanup of ALTER TABLE, CREATE VIEW, DELETE, INSERT, SELECT, or UPDATE statements. 
+
+    - 'State_freeing_items'
+      The number of threads being in 'freeing items' state: the thread has executed a command. Some freeing of items done during this state involves the query cache.
+
+    - 'State_init'
+      The number of threads per second being in 'init' state: this occurs before the initialization of ALTER TABLE, DELETE, INSERT, SELECT, or UPDATE statements. Actions taken by the server in this state include flushing the binary log, the InnoDB log, and some query cache cleanup operations. 
+
+    - 'State_locked'
+      The number of threads being in 'locked' state: the query is locked by another query.
+
+    - 'State_login'
+      The number of threads being in 'login' state: the initial state for a connection thread until the client has been authenticated successfully. 
+
+    - 'State_preparing'
+      The number of threads being in 'preparing' state: this state occurs during query optimization. 
+
+    - 'State_reading_from_net'
+      The number of threads being in 'reading form net' state: the server is reading a packet from the network. 
+
+    - 'State_sending_data'
+      The number of threads being in 'sending data' state: the thread is reading and processing rows for a SELECT statement, and sending data to the client.
+
+    - 'State_sorting_result'
+      The number of threads being in 'sorting result' state: for a SELECT statement, the thread is sorting index pages for more efficient access for nontemporary tables. 
+
+    - 'State_statistics'
+      The number of threads being in 'statistics' state: the server is calculating statistics to develop a query execution plan.
+
+    - 'State_updating'
+      The number of threads being in 'updating' state: the thread is searching for rows to update and is updating them. 
+
+    - 'State_writing_to_net'
+      The number of threads being in 'writing to net' state: the server is writing a packet to the network. 
+
+    - 'State_none'
+      The number of threads being in 'none' state: (NULL??) this state is used for the SHOW PROCESSLIST state.
+
+    - 'State_other'
+      The number of threads being in other state than the previously specified.
+
+    - 'Handler_commit'
+      The number of internal COMMIT calls per second. 
+
+    - 'Handler_delete'
+      The number of times that rows have been deleted from tables (calls per second). 
+
+    - 'Handler_discover'
+      The number of times per second that tables have been discovered asking the NDBCLUSTER storage engine.
+
+    - 'Handler_prepare'
+      The number of prepare phases of two-phase commit operations (calls per second). 
+
+    - 'Handler_read_first'
+      The number of times per second the first entry in an index was read (calls per second).
+
+    - 'Handler_read_key' 
+      The number of requests per second to read a row based on a key (calls per second).
+
+    - 'Handler_read_next'
+      The number of requests per second to read the next row in key order (calls per second).
+
+    - 'Handler_read_prev'
+      The number of requests per second to read the previous row in key order (calls per second).
+
+    - 'Handler_read_rnd'
+      The number of requests per second to read a row based on a fixed position (calls per second).
+
+    - 'Handler_read_rnd_next'
+      The number of requests per second to read the next row in the data file (calls per second).
+
+    - 'Handler_rollback'
+      The number of requests per second for a storage engine to perform a rollback operation (calls per second). 
+
+    - 'Handler_savepoint'
+      The number of requests per second for a storage engine to place a savepoint (calls per second). 
+
+    - 'Handler_savepoint_rollback'
+      The number of requests per second for a storage engine to roll back to a savepoint (calls per second). 
+
+    - 'Handler_update'
+      The number of requests per second to update a row in a table (calls per second). 
+
+    - 'Handler_write'
+      The number of requests per second to insert a row in a table (calls per second). 
+
+    - 'innodb_tables_in_use'
+      The number of InnoDB tables in use.
+
+    - 'innodb_lock_wait_secs'
+      The total number of seconds that InnoDB transactions have been waiting for locks.
+
+    - 'hash_index_cells_total'
+      The total number of Adaptative Hash Index cells of InnoDB.
+
+    - 'hash_index_cells_used'
+      The number of cells Adaptative Hash Index cells used by InnoDB.
+
+    - 'total_mem_alloc'
+      The total amount of memory allocated by InnoDB in bytes.
+
+    - 'additional_pool_alloc'
+      The amount of memory allocated in the additional pool by InnoDB.
+
+    - 'uncheckpointed_bytes'
+      The number of uncheckpointed bytes: the amount of recovery that'll have to be performed if there's a crash.
+
+    - 'ibuf_used_cells'
+      The number of cells of the Insert Buffer being used.
+
+    - 'ibuf_free_cells'
+      The number of free cells of the Insert Buffer.
+
+    - 'ibuf_cell_count'
+      The number of cells allocated for the Insert Buffer.
+
+    - 'adaptive_hash_memory'
+      The amount of memory in bytes used by InnoDB Adaptive Hash Index
+
+    - 'page_hash_memory'
+       The amount of memory in bytes used in page hash by Percona-enhanced versions of InnoDB.
+
+    - 'dictionary_cache_memory'
+       The amount of memory in bytes used in page hash by Percona-enhanced versions of InnoDB.
+
+    - 'file_system_memory'
+       The amount of memory in bytes used in page hash by Percona-enhanced versions of InnoDB.
+
+    - 'lock_system_memory'
+       The amount of memory in bytes used in page hash by Percona-enhanced versions of InnoDB.
+
+    - 'recovery_system_memory'
+       The amount of memory in bytes used in page hash by Percona-enhanced versions of InnoDB.
+
+    - 'thread_hash_memory'
+       The amount of memory in bytes used in page hash by Percona-enhanced versions of InnoDB.
+
+    - 'innodb_sem_waits'
+       The total number of InnoDB semaphore waits per second.
+
+    - 'innodb_sem_wait_time_ms'
+       The total number of milliseconds waited for semaphores.
+
+    - 'Key_buf_bytes_unflushed'
+      The amount of memory in bytes used for the key cache that have changed but have not yet been flushed to disk.
+
+    - 'Key_buf_bytes_used'
+      The amount of memory in bytes used for buffering index blocks (MyISAM tables).
+
+    - 'key_buffer_size'
+      The amount of memory in bytes designated for buffering index blocks for MyISAM tables.
+
+    - 'Innodb_row_lock_time'
+      The total time spent in acquiring row locks, in milliseconds.
+
+    - 'Innodb_row_lock_waits'
+      The number of times per second a row lock had to be waited for (waits per second). 
 
=== modified file 'README'
--- README	2011-06-23 20:57:30 +0000
+++ README	2011-06-24 06:42:35 +0000
@@ -1,40 +1,79 @@
+============
 INTRODUCTION
 ============
 
-This is a set of templates for monitoring MySQL servers  with
-Ganglia. The project is hosted
-at https://launchpad.net/percona-ganglia-mysql.
-
-Commercial support and enhancements are available through Percona, where the
-developer works.  Their website is http://www.percona.com
-
+This is a set of templates for monitoring MySQL-based servers with Ganglia. 
+The project is hosted at 
+
+  https://launchpad.net/percona-ganglia-mysql
+
+Commercial support and sponsored enhancements are available through Percona, 
+where the main developer works. You can find more information at
+
+  http://www.percona.com
+
+
+============
 INSTALLATION
 ============
 
-Installation instructions are online at
-http://code.google.com/p/mysql-cacti-templates/wiki/InstallingTemplates.
-
-If the templates do not match your polling interval, desired graph size, or any
-number of other qualities, you can easily generate your own.  Instructions are
-in the documentation linked above.
-
+Installation instructions are available in the INSTALL file at the base 
+directory of the distribution.
+
+It is assumed that Ganglia is installed and configured on the system 
+and won't be covered here. Instructions for these procedures can be found at
+
+  http://sourceforge.net/apps/trac/ganglia/wiki/ganglia_configuration
+
+
+===================================
+DOCUMENTATION AND COMMUNITY SUPPORT
+===================================
+
+Documentation is available at the Better Cacti's Templates' wiki:
+
+  http://code.google.com/p/mysql-cacti-templates/wiki/TableOfContents
+
+Descriptions of the metrics can be found in the METRICS file at the base
+directory of the distribution.
+
+Community support is available at its mailing list:
+
+  http://groups.google.com/group/better-cacti-templates.
+
+
+================
 BUGS OR PROBLEMS
 ================
 
-If you find any bugs or problems not listed in the FAQ, please enter an issue
-report at http://code.google.com/p/mysql-cacti-templates/.  Please make sure you
-read the official Cacti documentation and forums first.  Many of the issues and
-questions that come up are unrelated to these templates, and the answers are
-readily available in the Cacti manual or forums.
-
-Documentation is at the wiki hosted on
-http://code.google.com/p/mysql-cacti-templates/, and there is a mailing list at
-http://groups.google.com/group/better-cacti-templates.
-
+If you find any bugs or problems, please make sure of reading:
+
+ - Better Cacti Templates' FAQ:
+
+   http://code.google.com/p/mysql-cacti-templates/wiki/FAQ
+
+ - Cacti's official documentation:
+
+   http://www.cacti.net/documentation.php
+
+ - Cacti's forums:
+
+   http://forums.cacti.net/
+
+Many of the issues and questions that come up are unrelated to these templates, 
+and the answers are readily available in the Cacti manual or forums.
+
+If it is not listed there, please enter an issue or report it at
+
+  http://code.google.com/p/mysql-cacti-templates/issues
+
+
+============
 CONTRIBUTING
 ============
 
-This is an open-source project, and everyone is welcome to participate.  Just
-join the mailing list and introduce yourself.  Commit access to SVN, editing
-permission on the wiki, and anything else you need will be happily and speedily
-granted if you ask.
+This is an open-source project, released under the GPLv2 license, and everyone is 
+welcome to participate. Just join the mailing list and introduce yourself. 
+
+Commit access to SVN, editing permission on the wiki, and anything else you need
+will be happily and speedily granted if you ask.
 \ No newline at end of file