# HG changeset patch # User Myhailo Danylenko # Date 1345491540 -10800 # Node ID ca6ef5ecb3ceb80595688430aa8cd9ab8a767f14 # Parent ccf363bc801a4b8a4af80ecbd2e879e1b3b0efd9 Rearrange docs diff -r ccf363bc801a -r ca6ef5ecb3ce CMakeLists.txt --- a/CMakeLists.txt Wed Aug 08 14:44:20 2012 +0300 +++ b/CMakeLists.txt Mon Aug 20 22:39:00 2012 +0300 @@ -64,7 +64,7 @@ ## Installation install(TARGETS cmd DESTINATION lib/mcabber) -install(FILES cmd.rc COPYING README DESTINATION share/doc/${CPACK_PACKAGE_NAME}) +install(FILES docs/cmd.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}/cmd.avv DESTINATION share/mcabber/avv/modules RENAME cmd) diff -r ccf363bc801a -r ca6ef5ecb3ce README --- a/README Wed Aug 08 14:44:20 2012 +0300 +++ b/README Mon Aug 20 22:39:00 2012 +0300 @@ -1,46 +1,1 @@ - -This is a module for mcabber, that allows you to send shell -command output to your buddy. - -To use this module just load it (there are some options, described -in cmd.rc, but none of them is required for proper operation) and -use command 'cmd'. - -INSTALLATION - -To install it, you need: -cmake -make -gcc -glib -mcabber's headers -loudmouth headers (included from mcabber's) - -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 ccf363bc801a -r ca6ef5ecb3ce TODO --- a/TODO Wed Aug 08 14:44:20 2012 +0300 +++ b/TODO Mon Aug 20 22:39:00 2012 +0300 @@ -1,4 +1,1 @@ - -Header template option? -Option to strip leading/trailing whitespace - +docs/todo.mdwn \ No newline at end of file diff -r ccf363bc801a -r ca6ef5ecb3ce cmd.rc --- a/cmd.rc Wed Aug 08 14:44:20 2012 +0300 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,19 +0,0 @@ - -# Shell to use. Commandline to be executed is -# shell -c command -# Can be autodetected from environment variable SHELL. -#set cmd_shell = /bin/dash - -# Redirect stderr to stdout. If not, stderr will be discarded. -set cmd_redirect_stderr = 1 - -# Set message header to "[] $ " -# Note, that on muc rooms it will just send "$ " prior -# to command output, as message subject here sets room topic. -set cmd_header = 1 - -# Use room-like behaviour even on non-room buddies. -set cmd_header_inline = 0 - -module load cmd - diff -r ccf363bc801a -r ca6ef5ecb3ce docs/cmd.rc --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/cmd.rc Mon Aug 20 22:39:00 2012 +0300 @@ -0,0 +1,19 @@ + +# Shell to use. Commandline to be executed is +# shell -c command +# Can be autodetected from environment variable SHELL. +#set cmd_shell = /bin/dash + +# Redirect stderr to stdout. If not, stderr will be discarded. +set cmd_redirect_stderr = 1 + +# Set message header to "[] $ " +# Note, that on muc rooms it will just send "$ " prior +# to command output, as message subject here sets room topic. +set cmd_header = 1 + +# Use room-like behaviour even on non-room buddies. +set cmd_header_inline = 0 + +module load cmd + diff -r ccf363bc801a -r ca6ef5ecb3ce docs/index.mdwn --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/index.mdwn Mon Aug 20 22:39:00 2012 +0300 @@ -0,0 +1,9 @@ + +[[!meta title="mcabber-cmd"]] + +# Post command output to buddy in MCabber + +Module to send shell command output to to your buddy. +Output may be stretched in time (parts will be sent asap). + +[ [[!hg mcabber-cmd desc="SOURCE"]] ] [ [[README|readme]] ] [ [[TODO|todo]] ] [ [[RC|cmd.rc]] ] diff -r ccf363bc801a -r ca6ef5ecb3ce docs/readme.mdwn --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/readme.mdwn Mon Aug 20 22:39:00 2012 +0300 @@ -0,0 +1,50 @@ + +# Command output posting for MCabber + +This is a module for mcabber, that allows you to send shell command +output to your buddy. + +To use this module just load it (there are some options, described in +'cmd.rc', but none of them is required for proper operation) and use +command 'cmd'. + +# 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-cmd_*.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 ccf363bc801a -r ca6ef5ecb3ce docs/todo.mdwn --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/todo.mdwn Mon Aug 20 22:39:00 2012 +0300 @@ -0,0 +1,4 @@ + +* Header template option? +* Option to strip leading/trailing whitespace +