# HG changeset patch # User Myhailo Danylenko # Date 1345492164 -10800 # Node ID f0e3c123d5066d75481014d6c31930ae7441055c # Parent e01cbf23a88b9b09fe82ab2d45dfac4c9f934be2 Rearrange docs diff -r e01cbf23a88b -r f0e3c123d506 CMakeLists.txt --- a/CMakeLists.txt Wed Aug 08 14:45:02 2012 +0300 +++ b/CMakeLists.txt Mon Aug 20 22:49:24 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-disco # -# 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-disco 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 @@ -73,7 +73,7 @@ ## Installation install(TARGETS disco DESTINATION lib/mcabber) -install(FILES disco.rc COPYING TODO README DESTINATION share/doc/${CPACK_PACKAGE_NAME}) +install(FILES docs/disco.rc COPYING docs/todo.mdwn docs/readme.mdwn DESTINATION share/doc/${CPACK_PACKAGE_NAME}) install(FILES disco.h DESTINATION include/mcabber) install(DIRECTORY help DESTINATION share/mcabber) install(FILES ${PROJECT_BINARY_DIR}/disco.avv DESTINATION share/mcabber/avv/modules RENAME disco) diff -r e01cbf23a88b -r f0e3c123d506 README --- a/README Wed Aug 08 14:45:02 2012 +0300 +++ b/README Mon Aug 20 22:49:24 2012 +0300 @@ -1,54 +1,1 @@ - -This is a module for mcabber to send service discovery requests. - -It provides mcabber command 'disco'. To use this module just -load it - then command will be available. - -With this you can discover abilities of various jabber entities, -like servers, transports etc. Note, that it can only provide -information, what to do with this information (eg register to -entity, that supports it) is not this module's task. Note also, -that if you want to get abilities of some buddy, you should send -disco request to specific resource of that buddy (because of this -this command supports extended notation ./resource), if you'll -send request to bare jid, you'll get reply from server, that -serves that jid. - -INSTALLATION - -To install it, you need: -gcc -make -cmake -glib -loudmouth -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 ...-*.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 e01cbf23a88b -r f0e3c123d506 TODO --- a/TODO Wed Aug 08 14:45:02 2012 +0300 +++ b/TODO Mon Aug 20 22:49:24 2012 +0300 @@ -1,3 +1,1 @@ - -Enable use of caps cache by providing mcabber routine to get identity - +docs/todo.mdwn \ No newline at end of file diff -r e01cbf23a88b -r f0e3c123d506 disco.rc --- a/disco.rc Wed Aug 08 14:45:02 2012 +0300 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,3 +0,0 @@ - -module load disco - diff -r e01cbf23a88b -r f0e3c123d506 docs/disco.rc --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/disco.rc Mon Aug 20 22:49:24 2012 +0300 @@ -0,0 +1,3 @@ + +module load disco + diff -r e01cbf23a88b -r f0e3c123d506 docs/index.mdwn --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/index.mdwn Mon Aug 20 22:49:24 2012 +0300 @@ -0,0 +1,9 @@ + +[[!meta title="mcabber-disco"]] + +# Service Discovery requests for MCabber + +Module allows to send Service Discovery requests and +examine results. + +[ [[!hg mcabber-disco desc="SOURCE"]] ] [ [[README|readme]] ] [ [[TODO|todo]] ] [ [[API|api]] ] [ [[RC|disco.rc]] ] diff -r e01cbf23a88b -r f0e3c123d506 docs/readme.mdwn --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/readme.mdwn Mon Aug 20 22:49:24 2012 +0300 @@ -0,0 +1,59 @@ + +# Service Discovery + +This is a module for mcabber to send service discovery requests. + +It provides mcabber command 'disco'. To use this module just load it - +then command will be available. + +With this you can discover abilities of various jabber entities, like +servers, transports etc. Note, that it can only provide information, +what to do with this information (eg register to entity, that supports +it) is not this module's task. Note also, that if you want to get +abilities of some buddy, you should send disco request to specific +resource of that buddy (because of this this command supports extended +notation ./resource), if you'll send request to bare jid, you'll get +reply from server, that serves that jid. + +# Installation + +To install it, you need: + + * mcabber headers + * glib + * loudmouth + * 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-disco_*.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 e01cbf23a88b -r f0e3c123d506 docs/todo.mdwn --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/todo.mdwn Mon Aug 20 22:49:24 2012 +0300 @@ -0,0 +1,4 @@ + +* Use caps cache +* Document api +