# HG changeset patch # User Myhailo Danylenko # Date 1345508088 -10800 # Node ID bea3464128d08988fdd400027f435ad36a3484ac # Parent 55395c6ef7ea1a606018d56119af61dc7cf8b531 Rearrange docs diff -r 55395c6ef7ea -r bea3464128d0 CMakeLists.txt --- a/CMakeLists.txt Tue Aug 07 18:54:04 2012 +0200 +++ b/CMakeLists.txt Tue Aug 21 03:14:48 2012 +0300 @@ -1,10 +1,10 @@ -## Copyright 2009 Myhailo Danylenko -# This file is part of mcabber module writing howto examples. +## Copyright 2009-2012 Myhailo Danylenko +# This file is part of mcabber-marking # -# Examples are free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 2 of the License, or -# (at your option) any later version. +# mcabber-marking is a free software: you can redistribute it and/or +# modify it under the terms of the GNU General Public License as +# published by the Free Software Foundation, either version 2 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of @@ -64,7 +64,7 @@ ## Installation install(TARGETS marking DESTINATION lib/mcabber) -install(FILES marking.rc COPYING README TODO DESTINATION share/doc/${CPACK_PACKAGE_NAME}) +install(FILES docs/marking.rc COPYING docs/readme.mdwn docs/todo.mdwn DESTINATION share/doc/${CPACK_PACKAGE_NAME}) install(DIRECTORY help DESTINATION share/mcabber) install(FILES ${PROJECT_BINARY_DIR}/marking.avv DESTINATION share/mcabber/avv/modules RENAME marking) diff -r 55395c6ef7ea -r bea3464128d0 README --- a/README Tue Aug 07 18:54:04 2012 +0200 +++ b/README Tue Aug 21 03:14:48 2012 +0300 @@ -1,45 +1,1 @@ - -This is mcabber module to do the same command with several contacts. - -Useful example binding for '/mark toggle' is provided in marking.rc. -After you marked some buddies, you can then run '/marked do ' -to do 'command' with each of marked buddies jid's. 'command' must contain -one %s where jid should be inserted. Any other %'s should be escaped as -'%%'. - -INSTALLATION - -To install it, you need: -cmake -make -gcc -glib -mcabber headers - -Then do -$ mkdir build -$ cd build -$ cmake .. -$ make edit_cache -$ make -# make install - -Debian users can instead of make install do -$ fakeroot make package -# dpkg -i libmcabber-marking*.deb - -Users of other distributions can select appropriate package -generator, using cache editor. - -LICENSE - -This code underlies terms of GNU GPL v2 or later. You can find it in file COPYING -from this distribution or on a GNU web-site . - -CONTACTS - -I will be happy to get feedback, patches, suggestions, etc. -You can send me email or contact via jabber . - - -- Myhailo Danylenko - +docs/readme.mdwn \ No newline at end of file diff -r 55395c6ef7ea -r bea3464128d0 TODO --- a/TODO Tue Aug 07 18:54:04 2012 +0200 +++ b/TODO Tue Aug 21 03:14:48 2012 +0300 @@ -1,3 +1,1 @@ - -Change substitution semantics - something like $name for roster name, $jid for jid etc - +docs/todo.mdwn \ No newline at end of file diff -r 55395c6ef7ea -r bea3464128d0 docs/index.mdwn --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/index.mdwn Tue Aug 21 03:14:48 2012 +0300 @@ -0,0 +1,9 @@ + +[[!meta title="mcabber-marking"]] + +# Operations on multiple buddies for MCabber + +Allows to mark buddies and then run command for each of +them. + +[ [[!hg mcabber-marking desc="SOURCE"]] ] [ [[README|readme]] ] [ [[TODO|todo]] ] [ [[RC|marking.rc]] ] diff -r 55395c6ef7ea -r bea3464128d0 docs/marking.rc --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/marking.rc Tue Aug 21 03:14:48 2012 +0300 @@ -0,0 +1,6 @@ + +# Insert +bind 331 = mark toggle + +module load marking + diff -r 55395c6ef7ea -r bea3464128d0 docs/readme.mdwn --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/readme.mdwn Tue Aug 21 03:14:48 2012 +0300 @@ -0,0 +1,51 @@ + +# Operations on multiple buddies for MCabber + +This is mcabber module to do the same command on several contacts. + +Useful example binding for '/mark toggle' is provided in 'marking.rc'. +After you marked some buddies, you can then run '/marked do ' +to do 'command' with each of marked buddies jid's. 'command' must +contain one %s where jid should be inserted. Any other %'s should be +escaped as '%%'. + +# Installation + +To install it, you need: + + * mcabber headers + * glib + * cmake + * make + * c compiler (gcc) + * linker (binutils) + +Then do: + + $ mkdir build + $ cd build + $ cmake .. + $ make edit_cache + $ make + # make install + +Debian users can instead of make install do: + + $ make package + # dpkg -i libmcabber-marking_*.deb + +Users of other distributions can select appropriate package generator, +using cache editor. + +# License + +This code underlies terms of GNU GPL v2 or later. You can find it in +file COPYING from this distribution or on a GNU web-site +. + +# Contact + +I will be happy to get feedback, patches, suggestions, etc. +You can send me email or contact via jabber . + + -- Myhailo Danylenko diff -r 55395c6ef7ea -r bea3464128d0 docs/todo.mdwn --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/todo.mdwn Tue Aug 21 03:14:48 2012 +0300 @@ -0,0 +1,4 @@ + +* Change substitution semantics - something like $name for roster name, $jid for jid etc + * use parser? + diff -r 55395c6ef7ea -r bea3464128d0 marking.rc --- a/marking.rc Tue Aug 07 18:54:04 2012 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,6 +0,0 @@ - -# Insert -bind 331 = mark toggle - -module load marking -