• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..03-May-2022-

art/H03-May-2022-465394

m4/H30-Aug-2013-2,9122,689

po/H03-May-2022-9,4107,247

rc/H03-May-2022-42

src/H30-Aug-2013-8,2154,994

ABOUT-NLSH A D30-Aug-201365.8 KiB992945

AUTHORSH A D30-Aug-201335 21

COPYINGH A D30-Aug-201317.6 KiB341281

ChangeLogH A D30-Aug-201312.6 KiB372317

DoxyfileH A D30-Aug-201361.9 KiB1,5121,085

INSTALLH A D30-Aug-20139 KiB230175

Makefile.amH A D30-Aug-2013155 93

Makefile.inH A D30-Aug-201323.9 KiB767676

READMEH A D30-Aug-20131.8 KiB7341

README.xmlrpcH A D30-Aug-20131.5 KiB5639

aclocal.m4H A D30-Aug-201374 KiB2,0171,808

config.guessH A D30-Aug-201339 KiB1,3641,177

config.h.inH A D30-Aug-20132.7 KiB10269

config.rpathH A D30-Aug-201314.5 KiB572480

config.subH A D30-Aug-201328.9 KiB1,4711,330

configureH A D30-Aug-2013260.4 KiB8,8057,256

configure.acH A D30-Aug-20132.7 KiB9977

depcompH A D30-Aug-201313 KiB465298

install-shH A D30-Aug-20136.2 KiB277169

missingH A D30-Aug-201310 KiB337263

mkinstalldirsH A D30-Aug-20133.3 KiB151102

README

1
2 xCHM - the CHM viewer for UNIX
3 (c) 2003 - 2013 Razvan Cojocaru <rzvncj@gmail.com>
4
5
6 * Prerequisites
7
8 In order to be able to compile the code you need to have wxWidgets and
9 CHMLIB installed. You can get wxWidgets from:
10
11 http://www.wxwidgets.org
12
13 Get the GTK+ version (also known as wxGTK). xCHM currently compiles
14 with all flavours of wxWidgets, but only works well and looks truly
15 appealing with wxGTK, so I recommend against bothering to use it with
16 anything else.
17
18 You can get CHMLIB from:
19
20 http://www.jedrea.com/chmlib/
21
22 After you've installed the above you're ready for the next phase.
23
24
25 * Installing
26
27 Type ./configure --help if you're interested in parameters you can pass
28 to configure for compile switches. Most people will be perfectly happy
29 doing a:
30
31 ./configure && make
32
33 Once everything is built, type
34
35 make install
36
37 and the executable should be somewhere in your $PATH (hopefully :)).
38 Now you can just type
39
40 xchm
41
42 and start your session.
43
44
45 * Generating documentation
46
47 If you'd like to generate developer documentation go to the root
48 of the distribution and type
49
50 doxygen
51
52 This of course implies that you have doxygen installed. The documentation
53 will be generated in the doc directory in HTML and LaTex format. The doc
54 directory will be created in the process of creating the documentation so
55 it's ok that it's not present by default in the tarball.
56
57
58 * Legal stuff
59
60 As far as I know this is legal code. If you know that the code is in any
61 way illegal in your country, please drop me a note and stop using it / do
62 not install it.
63
64
65 * Contact
66
67 For bug reports and patches, please use the address above.
68 For everything else, count to 10 and if you still want to send the
69 message, go ahead. Can't promise I'll answer everything though.
70
71
72 * Happy reading!
73

README.xmlrpc

1XmlRpc interface documentation
2
3XmlRpc support enables 3rd party applications to issue load, change page, and
4close instructions to xCHM.
5
6In order to make use of the XmlRpc support in xCHM you must configure with the
7--enable-xmlrpc flag. You must also have the XmlRpc++ (0.7 or higher) library
8installed on your system. You can aquire this library at:
9	http://xmlrpcpp.sourceforge.net/
10
11
12Calls
13param 1
140 - Shuts down xCHM
15
161 - Loads a chmfile specified by param 2, and an optional contextID as param 3
17
182 - Loads a specified contextID within the file as param 2
19
20Results
210 - The request was not completed, this indicates a failure in the command. For
22    example if the call (1,file,id) is made with a valid file, but invalid id
23    the correct file will be loaded but the id will not be. Thus it will report
24    that the request was not completed.
25
261 - The request was completed successfully.
27
28
29Notes:
30
31File paths are relative to the xCHM executable, thus full path names are  the
32recommended method for opening files via XmlRpc.
33
34Example using Python:
35
36Launch xCHM with the XmlRpc server activated
37xchm --with-xmlrpc=port
38
39Launch python
40>>> import xmlrpclib
41
42# establish connection to xCHM XmlRpc server
43>>> s = xmlrpclib.Server('http://localhost:port')
44
45# tell xCHM to open /path/to/sch/file.chm
46>>> s.xCHM(1,'/path/to/chm/file.chm')
471 # success
48#tell xCHM to load the contextID from the current file.
49>>> s.xCHM(2,1234)
500 # failure
51>>> s.xCHM(2,1235)
521 # success
53# close xCHM
54>>> s.xCHM(0)
551
56