Index: valknut/valknut/docs/en/valknut.1 =================================================================== --- valknut/valknut/docs/en/valknut.1 (revision 262) +++ valknut/valknut/docs/en/valknut.1 (working copy) @@ -53,42 +53,63 @@ .ds f4\" '\" t .ta 8n 16n 24n 32n 40n 48n 56n 64n 72n -.TH "dcgui-qt" "1" +.TH "valknut" "1" .SH "NAME" -dcgui-qt \(em Direct connect client for linux +valknut \(em Multi-platform direct connect client .SH "SYNOPSIS" .PP -\fBdcgui-qt [OPTIONS]\fP +\fBvalknut [OPTIONS]\fP .SH "DESCRIPTION" .PP -Start \fBdcgui-qt\fP peer to peer client program. +\fBValknut\fP is a program the uses the Direct Connect protocol. It is compatible with other DC clients, such as the original DC from Neomodus, DC++, and Shakespeer. +.IP "-c " 10 +Lets you specify the path where valknut should find its configuration files. Useful if you want to have multiple configurations, eg. for testing. +.IP "--check-theme" 10 +Displays how many themes/styles are available and exits. +.IP "--disable-backtrace" 10 +is useful when you have compiled a debug version of valknut. If you want to produce a core file (for a bug report) you have to put this option when launching valknut. .IP "--disable-splash" 10 -Startup splash screen is not -shown. +Startup splash screen is not shown. .IP "--disable-theme" 10 -Theme support is turned off. Could be useful if -buggy themes are making dcgui-qt crash. -.IP "--check-theme" 10 -Displays how many themes/styles are available and -exits. -.IP "-c " 10 -Lets you specify the path where dcgui-qt should find -its configuration files. Useful if you want to have multiple -configurations, eg. for testing. -.IP "--disable-backtrace" 10 -is useful when you have compiled a debug version -of dcgui-qt. If you want to produce a core file (for a -bug report) you have to put this option when launching dcgui-qt. +Theme support is turned off. Could be useful if buggy themes are making valknut crash. +.IP "--disable-tray" 10 +Turns off the tray icon. Useful if your window manager doesn't support tray icons. +.IP "--help" 10 +Show the list of command line options and brief help on what they do. +.IP "--socketlog " 10 +Outputs a log of socket data to the file dcsocket.log. Valid values for param are none, send, recv or both. +.IP "--trayicon" 10 +Starts the application in tray icon mode, meaning the main window will not be visible. .IP "-v verboselevel 1 " .IP "-vv verboselevel 2 " -With level 1 you can see every path on create sharelist and with level 2 you see every path and file. +With level 1 you can see every path on create sharelist and with level 2 you see every path and file. .PP .SS Environment Variables: .IP "http_proxy" If set, the HTTP proxy server to use for downloading public hub lists. Needs to be in the form http://[:port] +.PP +.SS Keyboard Shortcuts: +.IP "Ctrl+A" 10 +Set Away Mode -> Away +.IP "Ctrl+F" 10 +Open Users Window +.IP "Ctrl+N" 10 +Set Away Mode -> Normal +.IP "Ctrl+O" 10 +Open Options Window +.IP "Ctrl+P" 10 +Open Spy Window +.IP "Ctrl+Q" 10 +Exit Program +.IP "Ctrl+S" 10 +Open Hub Search Window +.IP "Ctrl+T" 10 +Open Transfer List Drawer +.IP "Ctrl+U" 10 +Open Hub List Window .PP This manual page was written for the \fBDebian\fP distribution -because the original program does not have a manual page. +because the original program did not have a manual page. .SH "SEE ALSO" .PP @@ -97,7 +118,7 @@ .PP This manual page was written by Pasi Savilaakso pasi.savilaakso@pp.inet.fi for the \fBDebian\fP system (but may be used by others) with help of Andrew -Greig. Permission is granted to copy, distribute and/or modify this +Greig. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Index: valknut/valknut/docs/en/readme.txt =================================================================== --- valknut/valknut/docs/en/readme.txt (revision 262) +++ valknut/valknut/docs/en/readme.txt (working copy) @@ -4,5 +4,9 @@ # debian sarge #DSL="/usr/share/sgml/docbook/stylesheet/dsssl/modular/html/docbook.dsl" #DCL="/usr/share/sgml/declaration/xml.dcl" +# OS X with Fink (requires docbook-dsssl-nwalsh) +#DSL="/sw/share/sgml/dsssl/docbook-dsssl-nwalsh/html/docbook.dsl" +#DCL="/sw/share/sgml/dsssl/docbook-dsssl-nwalsh/dtds/decls/xml.dcl" +#perl -pi -e 's,docbook/dtd/xml/4.2/docbookx.dtd,/sw/share/xml/dtd/docbookx/4.2.0/docbookx.dtd,g;' manual.xml openjade -t sgml -V nochunks -d $DSL $DCL manual.xml > manual.html Index: valknut/valknut/docs/en/manual.xml =================================================================== --- valknut/valknut/docs/en/manual.xml (revision 262) +++ valknut/valknut/docs/en/manual.xml (working copy) @@ -3,6 +3,7 @@ "docbook/dtd/xml/4.2/docbookx.dtd" [ + ]> @@ -11,11 +12,19 @@ Andrew Greig + + Hanspeter + Niederstrasser + $Id: manual.xml,v 1.17 2005/02/13 19:15:43 mayhem Exp $ 2003, 2004, 2005 Andrew Greig + + 2007 + Andrew Greig, Hanspeter Niederstrasser + You can redistribute and/or modify this document under the terms of the GNU General Public Licence as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. For the purpose of applying the GPL to this document, I consider "source code" to refer to the Docbook XML markup. @@ -28,30 +37,34 @@ As I'm still not an expert on &appname; this document is nowhere near complete, and is very much a work-in-progress. Your comments, suggestions and corrections are welcomed, please write to me at agreig at flashmail dot com. - It is intended that this manual will be kept up-to-date with the latest releases of &appname;. It is currently being updated for the 0.3.4 release. The XML source code of this document is under CVS, which can be browsed at + It is intended that this manual will be kept up-to-date with the latest releases of &appname;. It is currently being updated for the 0.3.9 release. The XML source code of this document is under svn, which can be browsed at . About &appname; &appname; is a program the uses the Direct Connect protocol. It is compatible with other DC clients, such as the original DC from Neomodus, DC++ and derivatives. &appname; also interoperates with all common DC hub software. - &appname; is written by Mathias Küster mathen at users dot berlios dot de and is licensed under the GNU GPL. It is written in C++ and uses the cross-platform Qt (TM) library for its GUI. &appname; compiles and runs on Linux, FreeBSD, MacOSX and Windows. + &appname; was written by Mathias Küster mathen at users dot berlios dot de and is licensed under the GNU GPL. It is written in C++ and uses the cross-platform Qt (TM) library for its GUI. &appname; compiles and runs on Linux, FreeBSD, Mac OS X and Windows. Originally, &appname; was called DCGUI, which unfortunately was very similar to the name of another Linux DC client. It was then renamed to dcgui-qt to avoid confusion. However, trademark problems relating to the use of 'Qt' in the name forced another name change, to the rather unique &appname;. Most occurences of the old names have been replaced, but in some places, such as where it would cause too much disruption, the name hasn't been changed. + Official development of &appname; by Mathias Küster stopped after the release of version 0.3.7. At this time, there were several patches floating around in the forums. Edward Sheldrake organized them and put together the unofficial release for &appname; 0.3.8 under the project name wxdcgui. Current work is ongoing to release version 0.3.9 (spring 2007). + The original &appname; web site at ceased to resolve on April 1, 2007. Finding out more - Homepage: - Board/Forum: - Mailing list: + Homepage: + Board/Forum: + Mailing list: Contributors The following people have helped make this manual possible, by providing information, text or corrections: - Mathias Küster wrote the program, and is the source of most facts about it. + Mathias Küster wrote the program up to and including version 0.3.7, and is the source of most facts about it. + Edward Sheldrake took over the project from version 0.3.8 onward. Firechild wrote the original Bookmarks and Profiles sections. Jason Starr provided several corrections and explanations of program options. Stefan Huszics corrected my mis-capitalisation of kB, and provided bandwidth figures for some types of internet links. + Hanspeter Niederstrasser rewrote the documentation for building on Mac OS X and updated the manual for releases after 0.3.7. @@ -60,29 +73,23 @@ Getting &appname; Precompiled Packages - The &appname; download page is at . This is the best place to look for pre-packaged versions of &appname; for various operating systems. - - Debian packages are included in the official 'sarge' release, and can be installed by running apt-get install dcgui-qt. - + Currently, for &appname; 0.3.8 and higher, only the Mac OS X version is available as a precompiled package. It can be downloaded from . If you know of other binary releases for current &appname; please let me know at nieder at users dot sourceforge dot net. + The official &appname; 0.3.7 download page is currently defunct. This was the best place to look for pre-packaged versions of &appname; for various operating systems. + Debian packages for 0.3.7 are included in the official 'sarge' stable release, and can be installed by running apt-get install valknut. Gentoo users can do emerge &binaryname;. - - Contributed binary packages are announced on the distribution forum + Contributed binary packages were announced on the now defunct distribution forum. Source Code - Released versions are available at or . - - There are two parts you need, dclib and &binaryname;. The 'dc' tarballs contain both. - + Released versions of &appname; from 0.3.8 and higher are available at . + There are two parts you need, dclib and &binaryname;. You must compile and install dclib first, otherwise &appname; will fail to compile. - - If you really want to be on the bleeding edge you can get the latest CVS version with the following steps: + If you really want to be on the bleeding edge you can get the latest SVN version with the following steps: -cvs -d:pserver:anonymous@cvs.dcgui.berlios.de:/cvsroot/dcgui login (just press enter when prompted for a password.) -cvs -z3 -d:pserver:anonymous@cvs.dcgui.berlios.de:/cvsroot/dcgui co valknut -cvs -z3 -d:pserver:anonymous@cvs.dcgui.berlios.de:/cvsroot/dcgui co dclib +svn co https://wxdcgui.svn.sourceforge.net/svnroot/wxdcgui wxdcgui + This is a generic Subversion checkout command which will pull all modules, tags and/or branches of the project. In most cases, you will want to add '/trunk' to the HTTPS URL above to check out only the trunk (main development line). @@ -127,62 +134,90 @@ Compiling on Mac OS X - There are two ways of using &appname; on OS X: as a native application; or as an X11 application. The native version fits in more neatly with the standard Mac interface, wheras the X11 version requires you to run X as well. The X11 version may feel a bit strange to those with a Mac background, but will feel familiar to those with a UNIX background. - - For instructions on compiling the native version, see - - The instructions below for OS 10.3 Panther on X11 are derived from forum posts by drealynn42 and others. + There are two ways of running &appname; on OS X: as a native application; or as an X11 application. The native version fits in more neatly with the standard Mac interface, wheras the X11 version requires you to run X as well. The X11 version may feel a bit strange to those with a Mac background, but will feel familiar to those with a UNIX background. + The instructions below are for Mac OS X 10.3 Panther and above and are derived from forum posts by drealynn42, Nyzeta, nieder, and others. + Users migrating from Linux will note that the build uses dynamic linking. Because Mac OS X binaries also link to system libraries, it is unwieldly to deal with static and dynamic libraries at the same time. Furthermore, the native &appname;.app bundles eliminate the need for static linking. For these reasons, these instructions use only dynamic linking when building &appname;. Prerequisites - - Install XCode Tools from the CD that came with Panther. Make sure you choose to customize the install, and select the X11 SDK for installation as well. - Install Fink and FinkCommander. The official website is . Follow the installation instructions at . - - Run FinkCommander. Update the binary and cvs descriptions, then find each of the packages listed below and install them. + First, you have to decide whether you wish to use the X11 or the native Aqua version of &appname;. If building the X11 version, you have to install Apple's X11 and X11-SDK from the system install discs. Alternatively, you can also install X11 from Fink (see below). + Do not install both Apple's X11 and Fink's x11/xorg at the same time as this will cause serious issues. Read this FAQ entry for ways to troubleshoot your X11 installation if you accidentally installed both. + + Install XCode Tools from the CD that came with the OS. If you don't have the disc, you can download XCode from Apple (free registration required). Make sure you choose to customize the install, and select all the SDK packages. + Install Fink and FinkCommander (FinkCommander is optional but provides a graphical interface to Fink). The official website is . Follow the installation instructions at . + Run FinkCommander. Update the binary and rsync (preferred) or cvs descriptions, then find each of the packages listed below and install them. - qt3 - qt3-dev - libxml2 bzip2 bzip2-dev - openssl - openssl-dev + libpng3 + libxml2 + system-openssl + qt3 if building the X11 version + qt3-dev if building the X11 version + xorg if building the X11 &appname; version and not using Apple's X11 release + qt3mac if building the native Aqua &appname; version + qt3mac-dev if building the native Aqua &appname; version - Download the &appname; source code. The quickest way is by getting (1.3MB). Expand the file to somewhere convenient, for example your user directory. + Download the dclib and &appname; source code. Expand the files to somewhere convenient, for example your user directory. - Open X11 to compile dclib and &appname; in an x-terminal. + Open /Applications/Utilities/Terminal.app to compile dclib and &appname;. + + Setting up your system + To compile &appname; you need to set up your environment correctly so that the compiler can find all your files. Enter the following lines at the Terminal.app prompt: + +export PKG_CONFIG_PATH=/tmp/dcguibuild/lib/pkgconfig:$PKG_CONFIG_PATH +export CFLAGS="-I/sw/lib/system-openssl/include -I/sw/include $CFLAGS " +export LDFLAGS="-L/sw/lib/system-openssl/lib -L/sw/lib $LDFLAGS" + + + Compile dclib - cd to the dclib folder within the source folder. For example, if you put the dc-source-snapshot folder in your user directory, enter cd dc-source-snapshot/dclib. If the folder is within another folder, you will have to enter cd that-folder/dc-source-snapshot/dclib. Then enter the following commands when prompted: + cd to the dclib source folder. For example, if you put the dclib-¤tversion;.tar.bz2 folder in your user directory, enter cd dclib-¤tversion;. If the folder is within another folder, you will have to enter cd that-folder/dclib-¤tversion;. Then enter the following commands when prompted: -make -f Makefile.dist -./configure --prefix=/tmp/dcguibuild --disable-shared +make -f admin/Makefile.common +./configure --prefix=/tmp/dcguibuild make make install + This will finish installing dclib into a temporary directory. If you plan on using the X11 version of &appname;, it might be better to replace the value of --prefix to /usr/local or some other more permanent location. Compile &appname; - cd to the &appname; folder within the source folder. For example, enter cd dc-source-snaphot/dcgui. Then enter the following: - -make -f Makefile.dist -./configure --with-libdc=/tmp/dcguibuild --enable-static-link + + Compile &appname; for X11 + cd to the &appname; folder within the source folder. For example, enter cd &binaryname;-¤tversion;. Then enter the following: + +make -f admin/Makefile.common +./configure --with-libdc=/tmp/dcguibuild --with-ssl-dir=/sw/lib/system-openssl -- or if you get an error about qt3 -- -./configure --with-libdc=/tmp/dcguibuild --enable-static-link --with-extra-libs=/sw/lib/ --with-extra-includes=/sw/include/ --with-qt-includes=/sw/include/qt --disable-shared +./configure --with-libdc=/tmp/dcguibuild --with-ssl-dir=/sw/lib/system-openssl --with-extra-libs=/sw/lib --with-extra-includes=/sw/include --with-qt-dir=/sw --with-qt-includes=/sw/include/qt make make install - - If you get checking for X... configure: error: Can't find X includes. Please check your installation and add the correct paths! the X11 SDK was not installed correctly. Use your Panther CD to install this package then try again. - - Test the program compiled successfully by typing cd &appname;; ./&appname;. You may get some warnings, which you can ignore. The main thing is if the program starts up. - - For convenience you might want to make an alias for &appname; on your deskop. Look for the &appname; file in the &appname; folder within the &appname; folder. Keep in mind that this program will only run in X11. - - If you have previously used the native 0.2.19 version, you will find this version feels quite different since it is run in X11, but it basically operates the same. All of your files and settings will carry over, so don't worry about losing anything. + + + If you get checking for X... configure: error: Can't find X includes. Please check your installation and add the correct paths! and you are using Apple's X11, the X11 SDK was probably not installed correctly. Use your XCode Install CD to install this package then try again. + The &appname; program is now installed in /usr/local/bin. Test the program compiled successfully by typing /usr/local/bin/&binaryname;. You may get some warnings, which you can ignore. The main thing is if the program starts up. + Keep in mind that this program will only run inside X11, so X11 must be running first. + If you have previously used the native &appname; 0.2.19 version, you will find this version feels quite different since it is run in X11, but it basically operates the same. All of your files and settings will carry over, so don't worry about losing anything. + + + Compile the native Aqua &appname; + cd to the &appname; folder within the source folder. For example, enter cd &binaryname;-¤tversion;. Then enter the following: + +make -f admin/Makefile.common +./configure --with-libdc=/tmp/dcguibuild --with-ssl-dir=/sw/lib/system-openssl --enable-osx --enable-mac +-- or if you get an error about qt3 -- +./configure --with-libdc=/tmp/dcguibuild --with-ssl-dir=/sw/lib/system-openssl --enable-osx --enable-mac --with-extra-libs=/sw/lib --with-extra-includes=/sw/include/ --with-qt-dir=/sw/lib/qt3mac --with-qt-includes=/sw/lib/qt3mac/include +make +make install-osx-standalone-app + + You will now have a directory called &appname;.app in the location where you are building. To copy it to your Desktop, enter the following command cp -Rp &appname;.app ~/Desktop. Once the &appname; application is copied there, you can move it to wherever you want on your computer (such as /Users/(YOURNAME)/Applications) or /Applications. + To run the native &appname;, simply double click the &appname; icon. + Troubleshooting @@ -194,8 +229,17 @@ no configure: error: libxml2 must be installed. - then there is a problem with the installed xml libraries. Add --disable-xmltest to the ./configure command (both for dclib and &appname;) to bypass the check for libxml. + then there is a problem with the installed xml libraries. Make sure that libxml2 and libxml2-shlibs are both installed with FinkCommander. Alternatively, add --disable-xmltest to the ./configure commands above (both for dclib and &appname;) to bypass the check for libxml. + + Building a static application on Mac OS X + While not necessary, it is possible to build &appname; as a (partial) static application on Mac OS X. During the compilation of dclib, add the following parameters to the ./configure step: --enable-static --disable-shared. When compiling &appname;, add the following code to the ./configure step: --enable-link-static. This will create a &binaryname; executable with dclib built in. However, all the other required libraries will still be dynamically linked to the executable and will need to be present when running &appname;. + + + Using a package manager to install &appname; + &appname; is also available as a package within the Fink distribution. As of this writing there are no precompiled binaries for &appname; 0.3.8 and higher, but if you wish to install from source, Fink takes care of downloading, installing and building all the necessary dependencies with a single command. To install the X11 version of &appname; install the package &binaryname;-x11. To install the native Aqua version, install the package &binaryname;-aqua. + Once everything is finished, the X11 version can be run from Terminal.app (or an xterm) with the command /sw/bin/&binaryname;. The native Aqua version installs an alias in /Applications/Fink that can be run by double-clicking it from within Finder. + Compiling on OpenBSD @@ -346,7 +390,7 @@ Signal (11) received, stackdump follows; eax='00000000', ebx='00000000', ecx='00000000', edx='00000000', eip='00000000' --- retaddr=0x0, ebp=0x0 - it could be a bug, or it could be your configuration files are corrupt. Try renaming your ~/.dc folder temporarily, then run &appname; again. If it works fine then it was a problem with the configuration files. However if it continues to crash, check the &appname; board for others having similar problems with that version. You may want to compile a debug build. This will provide more information on the crash, which can help the developers find the cause. + it could be a bug, or it could be your configuration files are corrupt. Try renaming your ~/.dc folder temporarily, then run &appname; again. If it works fine then it was a problem with the configuration files. However if it continues to crash, check the &appname; board for others having similar problems with that version. You may want to compile a debug build. This will provide more information on the crash, which can help the developers find the cause. @@ -1185,6 +1229,7 @@ Getting and compiling plugins + This section is no longer valid as it points to a non-existent URL. Plugins aren't included in the core &appname;/dclib distribution, you have to get them seperately. You can find the source for released plugins on the developers page at or check out the module from cvs: cvs -d:pserver:anonymous@cvs.dcgui.berlios.de:/cvsroot/dcgui login