Quick Instructions for CLLOG $Id: Quick_Instructions.txt 43 2021-03-20 12:16:30Z df7be $ Installation instructions and first steps. ========================================== 1. Preface ---------- =========================================================================== Important note: Only a few of desired features are realized. Some additional features are only available as external console programs, they will be integrated in the main program "logw.exe" as soon as possible, for example the interface to eQSL. But you can add and edit your QSO data with this version. If you send hand written QSL cards, you can mark send and received cards. A full user's manual is under construction and will be delivered as soon as possible, please look sometimes on the project site on Sourceforge.net for new revisions on tab "Code", Directory "trunk/doc". =========================================================================== 2. Internet links for download of necessary software ---------------------------------------------------- See file "license.txt": NO WARRANTY ! Please take also attention for internet access of the Disclaimer in "liesmich.txt" in german language ! For Windows versions "setup.exe" and "*portable*" you don't need additional software, they are included in the installation archive. [1] Project site CLLOG at Sourceforge: https://sourceforge.net/projects/cllog/ Command for check out: (anonymous) # only the "trunk" branch mkdir -p ~/svnwork/cllog/cllog-code cd ~/svnwork/cllog/cllog-code svn checkout https://svn.code.sf.net/p/cllog/code/trunk trunk or # the whole repository mkdir -p ~/svnwork/cllog cd ~/svnwork/cllog svn checkout https://svn.code.sf.net/p/cllog/code/ cllog-code [2] Project site "Harbour Project" at GITHUB: https://harbour.github.io/ Source code repository https://github.com/harbour/core/ Get the code snapshot as ZIP file: - Tab "<> Code", Branch: "Master". - "Clone or download" ==> "Download ZIP" [3] Project site HWGUI at Sourceforge: https://sourceforge.net/projects/hwgui/ [4] GNU-make for Windows (on LINUX delivered with the system installation) Version 3.81 or higher. gnuwin32.sourceforge.net/packages/make.htm Source code: ftp.gnu.org/gnu/make 3. License ---------- Valid for source code: Copyright (c) 1997-2021 DF7BE Wilfried Brunken For details read file "license.txt" with exclusions for single files, disclaimer and more conditions. NO WARRANTY ! 4. Installation --------------- Windows ======= (recent release 32 bit, but runs also best on 64bit systems) Installation from Setup ----------------------- You find the installation archive on the CLLOG project site [1] in the tab "Files" Double click to "setup.exe": Answer the following questions: - Language: German (Deutsch) or English (Preset is recent system setting) - Your call sign (Hint: For installation of multiple call signs, call setup program again for every call sign, for example for family log or club stations) Continue with "First steps with CLLOG" Installation from portable version ================================== (At recent time recommended, until the first setup setup installation is created). On project site (tab "Files", directory "CLLOG" ) you find an archive with all installation files for download. CLLOG is installed or updated by a batch job. - Extract archive in a single directory (free choice of name, with suitable utility like "7-Zip"). - Open console command interface. - Change to directory in above mentioned base directory - Change to subdirectory "src" - Start installation with: install.bat : for example: C:\LOGBUCH\DF7BE Repeat for all logs with more call signs. If entered for an existing installation directory, so the recent instance is updated. Attention ! Make a data backup before executing an update installation. Continue with "First steps with CLLOG" Installation of application from source code ============================================ Create the development environment ------------------------------- Necessary for installation from source code. Windows ~~~~~~~ (tested on Windows 10 64 bit) Follow the instructions. Hint: The path values in environment variable PATH are also used for search of DLL's ! Requirements: ------------- - MinGW and Harbour Compiler: 1.) Harbour Mini-Gui (HMG) since version 3.x.x an higher, (contains MingW compiler and Harbour). The included Harbour version is most outdated for use with CLLOG, only the MinGW (gcc) compiler with additional packages is used. HMG is easy to install and contains all additional components for MinGW. Installation of HMG in directory C:\HMG.3.3.1 (sample) (with call of SETUP.EXE) Also you can use a gcc compiler (MINGW) with self collected components. 2.) Harbour Compiler: Self build Harbour compiler from source code ! Download from [2] as recent code snapshot, if no other instructions are published. (needs version with codepage DE858 supporting the Euro currency sign). - Install GNU- make tool. Download from [4]. Extract archives make-3.81-bin.zip make-3.81-dep.zip into directory C:\make (create manually). In this directory you must see the following directories: bin contrib man manifest share - Archive program 7-Zip od simular (7-Zip has its own format and support also ZIP files and UNIX archives) Optional (for developpers the first choice): - A good text editor, for example Notepad++, handles also text files with line endings for LINUX and MacOS, supports UTF-8 character set. Additional syntax highligtning of Harbour code files: Search in Internet for "xbase.xml". (Search for items: "xbase.xml notepad++") In the installation directory of Notepad++ a file "userDefineLang.xml" should exist. Copy the contents of xbase.xml with a normal text editor (of course also with Notepad++) into this file. The last line of the original file must contain "". Restart Notepad++ and you should find the syntax type "Harbour" in Menu "Language" and the source could now be colored. If not, use the import function, select file "userDefineLang.xml". - WinMerge (compare and merge of source codes) Install these Programms before start with Harbour and HWGUI. Preparations ------------ - Extract CLLOG source code from archive: Select directory for extract so that the install directory is: C:\CLLOG Create this directory manually before. In this directory you must see after extract process the following sub directories: src sh bin dokdxcc and many more. It is recommended to extract into this directory, but is is possible to choice another directory or check out directly from the Subversion repository. Read more under [1], modify LINUX path's simulator. - Execute the following steps in a console command window (CMD) or terminal application on LINUX. - Set path environment variable by batch script: cd C:\CLLOG\src pfad.bat (With this, no modification in Windows needed). Modify pfad.bat optional to your installation location before usage, if another location is desired. - Check for reachable C-compiler from MinGW. gcc --version gcc (GCC) 4.6.2 Copyright (C) 2011 Free Software Foundation, Inc. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - Check for make utility: make --version GNU Make 3.81 Copyright (C) 2006 Free Software Foundation, Inc. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. This program built for i386-pc-mingw32 Also: mingw32-make.exe expected output: mingw32-make.exe: *** No targets specified and no makefile found. Stop. In case of errors the Windows system sends an error message to the display (sample in german): Der Befehl "mingw32-make.exe" ist entweder falsch geschrieben oder konnte nicht gefunden werden. (The command "xxx" is written wrong or could not be found) Install Harbour from source code -------------------------------- Important ! The batch "pfad.bat" must be executed before ! - Extract Harbour source code from archive: Select directory for extract so that the install directory is: C:\harbour\core-master Optional modify batch "pfad.bat" before usage to your own needs, if another installation location is desired. - Start build by entering make in a console command window. Install HWGUI from source code ------------------------------ Important ! The batch "pfad.bat" must be executed before ! cd C:\ mkdir hwgui cd C:\hwgui mkdir hwgui cd hwgui (Base directory C:\hwgui\hwgui) ==> C:\hwgui\hwgui is installation location of HWGUI Here the sub directories of the installation: bin contrib doc image include lib obj samples source test utils patch HWGUI (optional): Download Patch level from CLLOG project site [1], (if published) ==> Tab "Files" , directory "HWGUI-Patch". Read install instructions in file "install.txt". Start build: makemngw.bat Check, if these 4 files are created in directory "lib": libhbxml.a libhwgdebug.a libhwgui.a libprocmisc.a For test, compile a sample program, here sample "a.prg": cd C:\hwgui\hwgui\samples Modify the the script "bldmingw.bat" concerning to the location of your installation. bldmingw.bat a creates "a.exe", call it and check by: ==> menu File/Open ==> "sample.dbf". If this program works normal, the build process of HWGUI is terminated successfully and is ready for build of CLLOG. Build CLLOG ----------- Important ! The batch "pfad.bat" must be executed before ! Call build script by entering makeall.bat Compiles all programs and copies the exe file into the bin sub directory. Install a CLLOG instance by entering: install.bat c:\xyz Installation of a new CLLOG instance in c:\xyz Installation einer neuen CLLOG-Instanz in c:\xyz Anlage einer neuen CLLOG-Instanz Drücken Sie eine beliebige Taste . . . Press 1 or 2 for language selection 1 - English 2 - Deutsch 3 - Abort Installation ECHO ist ausgeschaltet (OFF). Type 1,2 or 3, and then press ENTER : Enter 1 for english language. Update existing installation(s): ./install.bat The call syntax is the same for creating a new installation instance, but files modified by user will not be overwritten. These files are messaged by the script. Add a shortcut on the desktop ----------------------------- Description valid for Windows 10. Not needed for setup installation. On the desktop: Right mouse button: New ==> Shortcut Search in file browser the location of "logw.exe" Continue with "Next" Enter name of shortcut: Log Button "Finish" Repeat for every log (call sign). For console applications need to add command manually: Example: %windir%\system32\cmd.exe /c log LINUX: ====== Prerequisites: - Harbour compiler from source code download from [2] - Source code for HWGUI (tested with HWGUI Subversion release r2819 or higher) download from [3] - CLLOG source code download from [1] Please use the recent code snapshot's, if no other instructions are published ! (Tab "Code"). LINUX package installations: Install following packages as administrator (root): LinuxMINT: sudo apt-get install build-essential linux-headers-generic dkms sudo apt-get install libgtk2.0-dev Ubuntu 18: sudo apt-get install linux-headers-generic sudo apt-get install libgtk2.0-dev For CLLOG needed (Dialog in install.sh): sudo apt-get install dialog Optional: sudo apt-get install gedit (Text editor, alternative to xed) sudo apt-get subversion In case of compile problems the following packages must be installed: sudo apt-get install libxmu-dev libxaw7-dev libxt-dev After package installation restart the build process, (if "make" utility is used, the recent build process starts at the point, were the previuos build was aborted). As "non-root" installation: - Entries in .profile (template) of the used userid. (Modify values concerning to your desired installation location): #Eigene Erweiterungen HARBOUR_INSTALL=$HOME/Harbour/core-master PATH=$PATH:$HARBOUR_INSTALL/bin/linux/gcc export PATH LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$HARBOUR_INSTALL/lib/linux/gcc export LD_LIBRARY_PATH # Login new, so that the modified values become valid. - Open terminal, create directories in the home directory ($HOME) manually: mkdir hwgui mkdir -p Harbour/core-master mkdir cltest mkdir CLLOG mkdir -p svnwork/cllog - Get source codes for Harbour and HWGUI. If no other instructions published, download the recent code snapshot from main directory "trunk". As alternative the source code can be checked out directly from the repositories. For details see [1]. - Install Harbour In installation directory $HOME/Harbour/core-master: - Extract archive of Harbour with archiver application. (For last version from repository the base directory is "core-master") - Start build by entering "make" - Build HWGUI: Extract source code in directory $HOME/hwgui. Enter build commands (in base directory $HOME/hwgui): 1.) chmod 755 make_gtk.sh 2.) Modify Harbour installation directory in script make_gtk.sh: export HB_ROOT=$HOME/Harbour/core-master 3.) ./make_gtk.sh -hb 4.) Check, if the following libraries are created in sub directory "lib" after build run: libhbxml.a libhwgdebug.a libhwgui.a libprocmisc.a - Compile and test HWGUI sample program: (in directory samples/gtk_samples) - chmod 755 build.sh - Modify Harbour installation directory in build.sh from # export HB_ROOT=../../.. to (for example): export HB_ROOT=$HOME/Harbour/core-master - Compile a sample program: ./build.sh example - Start and test the program: ./example - Alternative: "dbview.prg". Open a DBF file for test, for example "samples/sample.dbf". - Get source code of CLLOG from project home page: - Start the terminal application - Change into installation directory cd $HOME/CLLOG - Call the home page of project on tab "Code": On the right side of site top you find the command for Subversion checkout, copy it per cut and paste into the command line of of the terminal application: svn checkout https://svn.code.sf.net/p/cllog/code/ cllog-code oder as an alternative get the code snapshot from directory "trunk". Create the CLLOG installation: ------------------------------ 1.) The main structure looks like this: - src - hilfe - dokdxcc - doc - bat ( contains batches for operation ) - sh ( contains shell scripts for LINUX for operation) und more directories. 2.) Empty directories are created automatically at run of makeall.bat/sh. 3.) chmod 755 *.sh makeall.sh 4.) Create target directory(ies): Start script for every call sign: ./install.sh Example: ./install.sh ~/cltest/DL1ABC 5.) Update existing installation(s): ./install.sh The call syntax is the same for creating a new installation instance, but files modified by user will not be overwritten. These files are messaged by the script. First steps with CLLOG ---------------------- The dokumentation is published in subdirectory "doc" in 2 formats: - User manual in one file of format "Open Document text" (*.odt) - HTML-Format. Open file "index.htm" with your preferred browser. First start of CLLOG: Enter command for start of main program "logw.exe" (Windows) or "./logw" on LINUX. You can create a desktop shortcut for every program as described in the previous chapter to start a program of CLLOG. After first start, all index file are created. Than a message appeared, that the demo data is active. The main window (Browse) shows the contents of the demo log. Now get experience with the usage of CLLOG. Enter new virual QSO's, edit data of existing records, open rounds an all other features. Attention ! The record with "DEMO-DATEN" can not be edited, it is general marker for the active demo data ! If you are ready for working with real data, the demo data must be deleted. In menu "Maintenance" you find the menu point "Delete demo data". If started, you were asked, that you really want to delete the demo data. In that case, the program was terminated und must be started new. You can only delete demo data, if no filter is set and no round is open. After restart, the browse list is empty and you can enter the first QSOs or import foreign data. The menu point "Delete demo data" is now deleted and does not appear in future. Also the message "Demo data of CLLOG detected" at start time should not appear any more. Enter at "Configuration" ==> "Personal data" your own data (call sign, QTH-Locator, postal adress, time zone ...) With command of log.exe you start the the console version of CLLOG. But the console version is outdated an has not so much features like the GUI version. Be shure, that only one of those programs run at same time. Import data =========== If you desire to import data of other log programs, you find external programs for executing in the command window or terminal. The source code of them can be find in directory "src\importe". The feature for import of ADIF files is implemented in the main GUI program. Also external program "adifimp.EXE" do this job. Please read instructions in "doc\en\imports\import.htm". If you need special support, create a ticket on the project site on Sourceforge.net or send us a E-Mail. Data backup =========== Because of the technical progress for storage media, there is no need for a special backup application. Make a backup of your log data before special jobs like imports or maintenance on a external media, a network drive or in a cloud based on following instructions: 1.) Terminate all programms of the CLLOG application set to avoid backup of open files. 2.) Delete index files: with command del *.ntx or in HWGUI main program in menu "Maintenance / Delete index files". 3.) Copy all files in the log directory on the backup media. 4.) Start CLLOG after succuessfull backup. The deleted index files are created new. For one backup you need (referenced by the demo data) about 50 MByte free space added with the size of the recent databases (*.dbf/dbt). For the next releases it is desired, to implement a comfortable back feature in the main program. List of programs ================ (Extract, not all listed) *) Console or terminal application LINUX without extension ".exe" clogw.exe "Panel Program": Starts Log and other additional utilities (configurable, under construction) logw.exe Log main program (Windows or X11 grafic GUI application with HWGUI) log.exe Log main program (Console or terminal application, outdated) *) lbledit.exe Program for creating and editing label files (adress lablels) *) db_edit.exe Common editing program oür editing existing DBF database files *) filtern.exe Program for creating and editing filter files (*.flt) *) dbcheck.exe Check program for existing DBF database files *) rundeimp.exe Import program for rounds and offline recordings from other CLLOG instance (for example family log), feature is integrated in logw.exe, outdated. *) lblprint.exe Check program for label files: loads a *.lbl file and prints a label *) with a fictive QSO (oudated, needs parallel printer port LPTx). owncall.exe Reads own call sign from file user.mem aus (only for batch scripts) *) locked.exe Checks by access to database for recent run of another program by lock trial (only for batch scripts, data backup) smv.exe Moves a single file (only for batch scripts) *) datum.exe Output date in ANSI format (only for batch scripts, Jobs for data backup) *) crudatm.exe Only for installation: Creates file user.mem with entry of own call sign. *) * ===== End of quick instructions ======