diff --git a/doc/accwiz1.png b/doc/accwiz1.png index ba9118c0a..ec8072807 100644 Binary files a/doc/accwiz1.png and b/doc/accwiz1.png differ diff --git a/doc/accwiz10.png b/doc/accwiz10.png index 0a9d69995..1612e18a6 100644 Binary files a/doc/accwiz10.png and b/doc/accwiz10.png differ diff --git a/doc/accwiz2.png b/doc/accwiz2.png index bf88f0a8b..ed18793e6 100644 Binary files a/doc/accwiz2.png and b/doc/accwiz2.png differ diff --git a/doc/accwiz6.png b/doc/accwiz6.png index 8c8bcd257..d9001cc3a 100644 Binary files a/doc/accwiz6.png and b/doc/accwiz6.png differ diff --git a/doc/accwiz7.png b/doc/accwiz7.png index e9ae019e1..6045d9555 100644 Binary files a/doc/accwiz7.png and b/doc/accwiz7.png differ diff --git a/doc/accwiz8_1.png b/doc/accwiz8_1.png index e9f3d3a84..bfeeae758 100644 Binary files a/doc/accwiz8_1.png and b/doc/accwiz8_1.png differ diff --git a/doc/accwiz8_2.png b/doc/accwiz8_2.png index be30ab6ef..478147126 100644 Binary files a/doc/accwiz8_2.png and b/doc/accwiz8_2.png differ diff --git a/doc/accwiz8_3.png b/doc/accwiz8_3.png index 2711b60f1..1c4be71a2 100644 Binary files a/doc/accwiz8_3.png and b/doc/accwiz8_3.png differ diff --git a/doc/accwiz8_4.png b/doc/accwiz8_4.png index 4dd812ca0..03e7386aa 100644 Binary files a/doc/accwiz8_4.png and b/doc/accwiz8_4.png differ diff --git a/doc/accwiz8_5.png b/doc/accwiz8_5.png index a2967c63b..f2ce2ab5a 100644 Binary files a/doc/accwiz8_5.png and b/doc/accwiz8_5.png differ diff --git a/doc/accwiz9.png b/doc/accwiz9.png index acc4dcaa8..e6fc19a06 100644 Binary files a/doc/accwiz9.png and b/doc/accwiz9.png differ diff --git a/doc/details-accounts.docbook b/doc/details-accounts.docbook index 6b30aa0c0..0691cf7bd 100644 --- a/doc/details-accounts.docbook +++ b/doc/details-accounts.docbook @@ -1,801 +1,815 @@ &Michael.T.Edwardes; &Michael.T.Edwardes.mail; &Roger.Lum; &Roger.Lum.mail; &Jack.H.Ostroff; &Jack.H.Ostroff.mail; 2018-02-01 5.0.0 Accounts The Accounts View The Accounts view provides a summary of all the accounts. It is similar to the Institutions view, except accounts are grouped under the Asset and Liability asset categories. Typical asset accounts include bank accounts, cash, and investments, while typical liability accounts include credit cards and loans. There are actually two other account categories: Income and Expense. Categories are a way to organize your transaction; they are grouped under either the Income or Expense account category) and are treated internally by &kmymoney; as accounts. They are described in more detail in the chapter on Categories. The Income and Expense account categories are always displayed in the Categories view, but it is possible to configure &kmymoney; to also display them on the Accounts view. account view account view Similar to the Institutions view, the Accounts veiw displays several columns with descriptive and summary information about each account. The rest of this chapter will focus on Asset and Liability account functionality. Income and Expense accounts, &ie;, Categories, are describe in the chapter on Categories. Creating an Account NOTE: You must have a file open before you can create a new account. If you do not have an existing file, you will need to create one. To create a new account, you can either select AccountNew - account... from the menu or choose the New - account... icon from the menu or choose the New + account... icon New from the toolbar. You can also create an account from the Accounts view; click on the Accounts icon in the view selector and then right click on the Asset or Liability tree icon and select New account... from the popup menu. The Institution (Bank) name Account Wizard The first step involves selecting an institution for the account. If this is an account for an institution you have already created, you can select the institution from the dropdown list. If you want to create a new institution, click on the New Institution button. This will bring up the New Institution Dialog, as described in the previous section. If this is not a bank account, or if you do not want to use online banking, you do not need to specify an institution. The Account Number and the IBAN (International Bank Account Number) are not currently used by &kmymoney;. These fields may be left blank and filled in at a later time; they are only required for online banking. To proceed to the next step click on Next. Account Account Wizard First, enter a name for the account. This name will be used to identify it. Next, select the type of account from one of the types available from the dropdown list. Different account types are handled differently withing &kmymoney;, so it is important to choose the correct type when creating the account. Also, different type of accounts require different setup information, and may display different pages in the new account setup wizard to collect that information. Checking A normal checking account, the type you get with any bank or credit union. Savings A normal savings account, the type you get with any bank or credit union. Credit Card An account to represent your credit card. Cash A general purpose account, typically used for accounts not held at a bank, such as the cash in your wallet. Loan An account to manage a loan for money either borrowed or lent. With a Loan account &kmymoney; automatically calculates interest payments to help you track the remaining principal on the loan. Loans with no interest might use the plain Asset or Liability type below, depending on whether the money is lent or borrowed. Investment An account to manage an investment such as stocks, bonds, or mutual funds. Asset An account to manage an asset that does not fit in one of the above types. Liability An account to manage a money you owe or a future expense that does not fit in one of the above types. This is most commonly used for loans with no interest. If interest needs to be calculated, you might be better using the Loan type above. Select the currency to be used for the account from the dropdown list. Enter the date the account was opened or select it from the calendar using the icon to the right. You will not be able to enter any transaction with a date earlier than the account opening date, but you can change this date later, if necessary. Enter the opening balance for the account. If this is an existing bank account, this information can be found on your statement. If it is a new account, the opening balance can be left at zero. Selecting the Preferred Account check box will allow preferred access in some dialogs and views of &kmymoney;. To proceed to the next step click on Next. Credit Card Accounts When creating a Credit Card account, after entering the basic information and clicking Next, you can optionally have &kmymoney; create a scheduled transaction for you. Account Wizard If you want such a transaction generated, make sure the check box is selected and enter the required information. Click on Next to continue. Investment Accounts - For Investment accounts, you have the option to create an associated Brokerage - account. For more information see Investments + In &kmymoney;, Investment accounts contain only equities (stocks, bonds, + &etc;) but do not contain cash. (This is why you cannot specify a Opening + balance for an Investment account.) If a transaction in an Investment account + requires or generates cash (such as to buy or sell stock,) a Brokerage account + is used for the cash. Brokerage accounts are described further in the chapter + on Investments. When you create a + new Investment account, after entering the basic information, and clicking + Next, you have the option to create an associated + Brokerage account. Account Wizard + + + It is generally best to create the Brokerage account here, which will be given + the same name as the Investment account, with "(Brokerage)" appended. + Currently it is not possible to specify the opening date or balance for the + Brokerage account at this point; you may do by editing the account details + after the account has been created. + Loan Accounts Loan accounts are special accounts used to help you manage Loans with interest and scheduled repayments. By providing &kmymoney; with information about the loan, &kmymoney; can help you track interest payments and the remaining principal of the loan. - Account Wizard On the Details page you enter the general information about the loan. First, select whether you are borrowing or lending money. If you are borrowing money the loan will be listed in Accounts under Liabilities. If you are lending money the loan will be listed under Assets. Next, select the payee or payer of the loan. As always, if the name doesn't yet exist in the Payees list, enter it here and &kmymoney; will create it for you. The next three items are for handling Loans on which you've already made - payments. If you select Yes in the "Have you made/received any payments yet?" - item you can then select whether you want to record all payments or just those - from the beginning of the current year. If you want to record from the - beginning of the current year, you are than asked to input the current - balance. + payments. If you select Yes in the "Did you make/receive any + payments yet?" dropdown, you can then select whether you want to + record all payments or just those from the beginning of the current year. If + you want to record from the beginning of the current year, you are than asked + to input the balance at the beginning of this year. - Then, select how often payments will be made and how often interest is + Next, select how often payments will be made and how often interest is compounded. Compounding is where the interest is added to the amount owed on the loan so that when the interest is next calculated there will be more interest paid on the interest. It's common for interest to be compounded at the same frequency that payments are made. -Next, enter the date the first recorded payment will be made. + + Next, enter the date the first payment to be recorded. Finally, enter information about how the interest rate varies. If the loan is fixed-rate there is nothing to do. If the rate varies, select Variable in - "Type of interest rate" and then enter the interval between interest rate - changes and the date the first change of interest rate is due: &kmymoney; will - ask you to update the interest rate when that date arrives. + "Type of interest rate" and then enter the interval + between interest rate changes and the date the first change of interest rate + is due: &kmymoney; will ask you to update the interest rate when that date + arrives. Click Next to continue. - Account Wizard The Payments page is where you enter the payment and interest values for the loan. First, select whether the interest rate is calculated when the payment is received or when it becomes due. If you don't know, leave it on the default value. Next, enter the following values: Loan amount - The amount of the loan. + The amount of the loan. Interest rate The annual percentage interest rate of the loan. Term The length of the loan. Enter a number and select either Months or Years. Payment (principal and interest) - The amount paid for each loan payment. This is the total of the - principal and interest paid with each payment. + The amount of each loan payment. This is the total of the principal and + interest paid with each payment. Balloon payment Additional final payment made at the end of the term to pay off the remaining principal of the loan. For a repayment loan this is often zero. For an interest-only loan this will be the same as the loan amount. Finally, use the Calculate button to check the values you have entered. You must have entered either all or all but one of the values listed above. If you omit two or more values the button is disabled because it is not possible to check that the entered values are consistent: in that case you will not be able to use the Loan account facility in &kmymoney; and will instead have to use a Liability or Asset account to track the loan manually. - If you omit one value &kmymoney; will try to calculate it for you. If you + If you omit one value, &kmymoney; will try to calculate it for you. If you have entered all values &kmymoney; will check the values are consistent. &kmymoney; will not adjust entered values other than the "Balloon payment", which it may adjust slightly to deal with rounding. If the values are - inconsistent or &kmymoney; cannot calculate the omitted value &kmymoney; will + inconsistent or &kmymoney; cannot calculate the omitted value, &kmymoney; will let you know so that you can correct any errors and repeat the calculation. - + - Once the values are consistent the Next button is + Once the values are consistent, the Next button is enabled and you can advance to the next page. - Account Wizard - + The Fees page is where you can enter any fees added to the loan payments. - + If there are any fees press the Additional Fees button. The Transaction Split editor will be displayed for entry of the fees. Any lines added here will be included in the payment schedule for the loan. When you save the splits the Fees page will display the principal and interest - payment, the total additional fees and the total periodic payment. + payment, the total additional fees, and the total periodic payment. - + - Account Wizard - + &kmymoney; will create a scheduled transaction for your loan. The Schedule page is where you enter the remaining details needed to create the schedule. First enter the Category to which loan interest will be assigned. Then enter the account from which the loan payment will be made. The page also displays the first payment date for which the Schedule will be created. - Account Wizard Optionally, &kmymoney; can create a transaction representing what was received or paid when the loan was created. If you borrowed or lent cash select the account from which or to which the loan amount was paid. If you borrowed money to purchase a car you can select or create an Asset account to help you track the value of the new car. - If you re-financed an existing Loan check the "Refinance existing loan" - check box, select the Loan account and &kmymoney; will create a transfer - transaction paying off the existing loan. + If you re-financed an existing Loan, check the "Refinance existing + loan" check box, select the Loan account and &kmymoney; will create + a transfer transaction paying off the existing loan. - If you don't want to create the payout transaction, check the "Do not create - transaction" check box. + If you don't want to create the payout transaction, check the "Do + not create payout transaction" check box. Parent Account Parent Account Account Wizard - This is the penultimate step in creating a new account. A tree of accounts is - displayed. The tree will be of your Asset or Liability accounts, depending on - the type of account that is being created. - - - - Select the account you wish contain the new account. If you do not select a - parent account, the new account will be created at the top level. + This is the penultimate step in creating any new account except a loan. + Depending on the type of account that is being created, a tree of your Asset + or Liability accounts will be displayed. The Parent Account page is not currently shown for Loans because they cannot be created as subaccounts. Also, Investment accounts cannot contain other accounts so they are not shown in the tree. + + + Select the account you wish contain the new account. If you do not select a + parent account, the new account will be created at the top level. + + Review and save the account details Review Account Wizard This is the final step in creating a new account. A summary of the information - entered is displayed. Review it, and if everything is OK press the Finish - button. Otherwise, either press the Back button to make - corrections or the Cancel button to abandon creating a new account. + entered is displayed. Review it, and if everything is OK press + Finish. Otherwise, either press + Back to make corrections or + Cancel to abandon creating the new account. - NOTE: The Type and Currency cannot at present be changed after the account is created. + NOTE: The Type and Currency cannot at present be changed after the account is + created. Opening / viewing accounts To open an account in the Ledger view you can either click on the link to the account from the Home view, or click on the Ledgers icon in the view selector and select the account in the drop down box at the top of the view. Alternatively, in the Account view, either double-click the account entry or right click and select Open ledger. Editing Account Information To edit a particular account, right-click that account and choose Edit account... or with that account open in the ledger, select AccountEdit Account.... A window will pop-up with several tabs, each allowing you to view and change certain information about the account. For more information on any of these details, see the section on creating a new account. Edit an account Edit account information General View the general information about the account, and change the name, start or opening date, as well as some of the other basic settings of the account. Institution View and change the associated banking institution and account numbers. You can also create a new institution here. Hierarchy You can change the parent account by clicking on another parent account in this view of the account hierarchy. Limits This tab is only present for asset and liability accounts. If you enter amounts in the available fields, &kmymoney; will warn you when the account balance reaches those values. Tax Here you can check whether this is a VAT account, and whether to include this account on tax reports. Online Settings This tab is only be present if the account has been mapped to an online account. It has three subtabs. Account Details This shows the status of the online connection, the bank/broker and account number, and allows you to store or change the password for the online account. OFX Details Here you can adjust certain details &kmymoney; uses when it establishes an OFX connection with the institution. This should only be necessary if you get certain errors when you first set up the online account, or perhaps if your institution changes its OFX server software. Import Details Here you can tell &kmymoney; what to use as the start date for the import. In addition, starting with version 4.6, you can choose whether the payee's name is based on the PAYEEID, NAME, or MEMO field of the imported transaction. Deleting accounts To delete an account, first remove all the transactions from that account in the ledger. Next, find the account in the accounts view and after right clicking on the entry to show the popup menu select Delete account... from the popup menu. If you are unable to delete an account which looks like it has no transactions in it, check your filter. See Settings Configure &kmymoney; General Filter . Clear all filters. Set the start date to 1.1.1900 or so. There may be transactions in your ledger that are not shown, for example, if you have inadvertently typed in the wrong year when making an entry so that an entry remains outside the opening date of &kmymoney;. This appears beneath the ledger page as remaining funds. diff --git a/doc/firsttime.docbook b/doc/firsttime.docbook index 3327824d4..f984e1932 100644 --- a/doc/firsttime.docbook +++ b/doc/firsttime.docbook @@ -1,1036 +1,1035 @@ &Michael.T.Edwardes; &Michael.T.Edwardes.mail; &Jack.H.Ostroff; &Jack.H.Ostroff.mail; 2018-02-01 5.0.0 Using &kmymoney; for the first time Running &kmymoney; for the first time Once &kmymoney; has fully loaded two windows will be opened. The top window, 'Tip of the Day' offers one of a series of important or useful pieces of information about the application. Tip of the Day Tip of the Day You are recommended to quickly read through these tips by pressing on the Previous and Next buttons at the bottom of the window. Once you have read the tips the window can be closed; it will re-open each time &kmymoney; is started. To stop this default behavior, uncheck the appropriate option on the Tip of the Day window. Tips can be read at anytime by selecting Show tip of the day from the Help menu within &kmymoney;. All tips have been extracted from the Frequently Asked Questions list (FAQ) that provides more detailed help and can be found on the project website and in this manual. Please click on Close to close the Tip of the Day dialog. When you run &kmymoney;, it might not look exactly like the screenshots in this manual. Many details, such as fonts, colors, and icons, can be customized, either using the SettingsConfigure &kmymoney;... dialog or the KDE System Settings application, depending on your operating system. The main window The Main Window The Main Window The &kmymoney; main window consists of four major parts A. The menu bar B. The toolbar C. The View selector D. The view The menu and toolbars provide access to the features of &kmymoney; and allow you to Create files or configure how &kmymoney; operates. The view selector consists of at least eleven icons in the left side of the main window, depending upon the software provided by your system. More icons could be added by various plugins. By clicking on an icon, the view window on the right hand side is loaded with the appropriate view of your financial data. Each view provides a unique representation of your financial situation and allows you to view or edit the information shown. The view selector may contain the following icons Home View Home: A configurable overview of your current financial situation (or an introduction page when no data file is open). Institutions View Institutions: All of your institutions and accounts displayed in a hierarchy. Accounts View Accounts: All of your accounts displayed in a hierarchy. Schedules View Scheduled Transactions: Your recurring bills and deposits. Categories View Categories: Special accounts that provide a means for you to group associated transactions. Tags View Tags: Special accounts that provide an additional means to Categories for you to group associated transactions. Payees View Payees: All Payees used by &kmymoney;. These are all the people or organizations you pay money to or receive money from. Ledgers View Ledgers: Your account transactions. Investments View Investments: Your portfolio summary. Reports View Reports: A collection of useful reports, providing alternate, customizable views of your financial data. Budgets View Budgets: Your budgets Forecast View Forecast: This view provides a forecast of your accounts and categories Outbox View Outbox: Used by the online banking module to provide feedback on running processes. This view is provided by the KBanking plugin and may not be present on your system. Creating a new file &kmymoney; keeps all the data about your finances in a file. As was stated in Defining the accounts (personal records), you can keep more than one set of accounts, but the data for each will be kept in a separate file, and &kmymoney; can only have one file open at a time. See the chapter on File Formats for more details about &kmymoney;'s data files. To create a new file you can either select FileNew from the menu or choose the New icon from the toolbar. In addition, if the main welcome page is displayed, you can also select the first link: "Get started and setup accounts." &kmymoney; will then open the New File Setup Wizard which will guide you through the process of creating the file. Personal Data Page Personal Data Page Since all fields are optional, you can use &kmymoney; without entering any information now. Any information entered here is used only to personalize your file. In the future, it may be used in some reports and for online banking. If &kmymoney; requires any personal information in future releases and finds none, you will be prompted to enter the relevant data then. Please enter your name and address or nothing and press Next. In case you have an address for yourself stored in the &kaddressbook;, the button Load from Addressbook is enabled and pressing it imports all information into &kmymoney;. &kmymoney; supports multiple currencies. To set your base currency (the currency you use day to day and which will be used for your reports), select the appropriate entry from the list provided and press Next. A default will be selected from &kmymoney; based - upon your locale settings. If you don't see your currency, be sure to look - through the entire list, in case it it simply not sorted as you might expect. + upon your locale settings. In the following example, US Dollar has been selected as the base currency. Base currency selection Page Base currency selection page The following page allows you to create an initial account. For the typical &kmymoney; user this is a checking account. Checking account creation Page Checking account creation page Enter the name of the account and a possible account or reference number assigned by the institution managing the account. Enter the opening date of the account and the opening balance of the account. For example, you want to use &kmymoney; to manage all your finances as of 2008-01-01, then enter the balance of the account at the beginning of this date. The number can possibly be obtained from a paper statement. Also enter the name and routing number of the institution, though this information is optional and only required for online banking purposes. In case you don't want to setup an initial account, please uncheck the check box. Once finished, press Next to proceed. Account template selection Page Account template selection page Choose the appropriate country and account template(s). Each template provides a different set of categories for organizing your finances. Multiple templates, even from different countries, can be selected using a combination of &Ctrl; and &Shift; together with the left mouse button. The account hierarchy to be setup will be shown in a preview part of the wizard. In case you cannot find a template that suits your needs, don't select a template at this time, and you can manually set up categories later. Once finished with the template selection press Next to proceed. The next page of the wizard allows you to setup user preferences. If you select the checkbox, the application settings dialog will be displayed after you have completed the account setup wizard. Press Next if you are done and want to proceed. Preference Page Preference page The last page of the wizard allows you to select the location and filename that will be used to store your financial data. Initial values will be constructed out of your HOME folder and user name. In case the file exists, a warning will be displayed which reminds you to select a name of a non-existing file. Filename selection Page Filename selection page Now you have entered all relevant information to create the file. Press Finish and &kmymoney; will create the file for you and open it. Creating accounts There are multiple ways you can create an account, which are described here: Using the menu To create an account using the menu select AccountsNew account. Using the Accounts view To create an account using the accounts view click on the Accounts icon in the view selector to display the Accounts View. Right click on the either the Asset tree icon or the Liability tree icon in the right hand view and select New account from the popup menu. The Asset tree holds all of your accounts that are an asset, such as savings and investments. Liabilities are accounts that represent money you owe, such as loans and credit cards. These and all the other account types are discussed in more detail later in this manual. Using the toolbar If the New Account... button is displayed on the toolbar, you can click it to create an account. Note that &kmymoney; uses context menus a lot throughout the whole application. If you find yourself stuck trying to figure out how to do something, try right-clicking where you would expect to see a feature. Creating a new account by either method opens the New Account Wizard. This wizard will take you step by step through the process of creating an account, gathering the required information at each step. To navigate through the pages click on the Next and Back buttons. Create an account using any of the previously mentioned methods to continue. A full description of creating accounts can be found in the Accounts section. Now that one or more accounts exist in &kmymoney;, your account summary is shown in the Home view. You can create transactions manually in the Ledgers view, or set up automatic transactions through the Schedules view. Schedules Sometimes called a recurring transaction, a Schedule is a transaction that occurs one or more times over a certain period of time. A typical example is your pay check that you receive every month or week. Rather than have to enter the transaction details each time you get paid, you can instruct &kmymoney; to create a schedule that will enter a transaction for you when you get paid. To maintain schedules click on the Schedules icon in the view selector. Categories To maintain categories click on the Categories icon in the view selector. A full description of this topic can be found in the Categories section. Tags To maintain tags click on the Tags icon in the view selector. A full description of this topic can be found in the Tags section. Payees To maintain your list of payees click on the Payees icon in the view selector. A full description of this topic can be found in the Payees section. Quicken Interchange Format (QIF) Import If you currently use another financial manager application, &kmymoney; can import an account's transactions as long as they can be exported or saved in a format &kmymoney; understands. The most common of these is the Quicken Interchange Format (QIF). Most financial programs can export this format, although the different applications' methods of exporting QIF is not discussed here for brevity. A full description of this topic can be found in the QIF Import section. Searching for transactions &kmymoney; provides a useful and powerful transaction search facility in the form of the search dialog. The search dialog can be opened from the toolbar using the Find icon or by selecting Find Transaction from the Edit menu. A full description of this topic can be found in the Search section. Reconciliation At some point you will want to reconcile the transactions you have entered with the transactions listed in a statement, be it a bank statement, credit card statement, loan statement, or any other statement. Reconciliation involves matching what you have entered with what the statement lists. If any discrepancies are found then either you or the person who created the statement have made a mistake. To reconcile an account, first select the account, either from Accounts view or from Ledgers view. Then, either click on the Reconcile icon on the Toolbar, or select Reconcile from the Account menu. A full description of this topic can be found in the Reconciliation section. Backing up Now that you have created some accounts and entered transactions it's a good idea to perform a backup. Because the file used by &kmymoney; is a standard Unix file you can just copy the file to another location to back it up or use the dialog provided by &kmymoney;. Using the dialog is the preferred method because if &kmymoney; ever starts using other file formats, such as SQL, then it would be much harder to copy the file manually. To backup your file through &kmymoney; Select Backup from the File menu and enter the folder where you wish the file to be saved. If the folder needs mounting first and you have the sufficient privileges then check the tick box labeled Mount this directory before backing up and click on OK. The file will be saved to the folder specified with the current date appended to the filename so it is easy to see the date the file was backed up. Launching &kmymoney; Most commonly, you will launch &kmymoney; from an icon or a start menu of your window manager. In this case, the default behavior is that &kmymoney; will open the last file you had open. However, in some circumstances, you will want or need to launch &kmymoney; from the command line. For a complete description of all the available command line options, see the man page for &kmymoney;. However, there are two special cases which we describe here. <command>kmymoney -n</command> The -n option tells &kmymoney; not to open the last file it had open. This can be useful if the program crashes on startup. <command>kmymoney <path to file></command> Giving &kmymoney; a filename on the command line tells it to open that file instead of the last file it had open. You can use the name of any valid &kmymoney; file, as described in the chapter on file formats. In addition, this can be used to import a GnuCash file. How to move &kmymoney; to a new computer Moving your data If you get a new computer, it's very easy to move your data. In fact, all you have to do is to copy your &kmymoney; data file. The name of the file is shown in the title bar when &kmymoney; is running, it usually ends in .kmy. The first time you run the application on the new computer you will have to tell it where you have put the data file, either by running from the command line, or from the FileOpen... menu. You should even be able to move between &Windows;, &MacOS;, and &Linux; systems. If you have encrypted your data file, be sure the appropriate software and keys have also been set up on the new computer. If your data is in an SQL database, refer to documentation for your database software for guidance on migrating your data. Note that this assumes you have installed the same version of &kmymoney; on the new computer as you were running on the old computer. Installing a newer version should also be safe, but you need to be aware of any issues related to that upgrade. Any such issues should be noted in the release notes for the new version. Moving your settings If you only move your data file to the new machine, as described in the previous section, &kmymoney; will work correctly, but you will have lost any settings you changed from the default on your old machine. To maintain these settings, you also need to copy your configuration file. This file is called kmymoneyrc. This file will be in a directory with other &kde; application configuration files. On a &Linux; system, this will be in $KDEHOME/share/config where $KDEHOME is usually .config within your home directory. If you are migrating from a version of &kmymoney; prior to 5.0 to 5.0 or later, the old location of $KDEHOME was .kde4. Moving plugin settings If you have run any &kmymoney; plugin, such as the csv importer or exporter, it may also have created a configuration file in that same directory, such as csvimporterrc or csvexporterrc. These should also be copied to the new computer. As with the main data file, this assumes the same version of the plugin on both computers. Upgrades are generally safe, but if the functionality of the plugin has changed greatly, it is advisable to carefully test using the old configuration file, to be sure the plugin behaves as you expect. Note that when upgrading from a previous version to version 5.0 or higher, the location of the template files used by the plugin for printing checks has changed. Please consult the release notes or the project website for more details. These instructions are solely for moving your &kmymoney; data and settings. However, there may be important items which are stored by &kde; and not by &kmymoney;, such as passwords stored in kwallet. Moving other parts of your &kde; setup is beyond the scope of this manual, although many of the relevant files are also stored under $KDEHOME. Contacting the Developers / Reporting Bugs Contacting the developers For general questions or comments about &kmymoney;, there is a users' mailing list &userlist;. (more details here.) In addition, you can contact the developers through their mailing list &devlist;. (more details here.) Since replies are often sent only to the list, you may not get any response unless you subscribe to one of the lists before sending to it. We're happy to hear about your experiences using &kmymoney;. Reporting bugs To report a bug please use the interface provided by &kmymoney; by selecting HelpReport Bug and filling in the required information. However, in case you have any difficulties with that method, you can report a bug (or file a wish-list or enhancement request) directly at the &kde; bug reporting web site. Reports should be filed against the product kmymoney. In any case, before reporting a bug, please read through the guidelines below. Following them will make it more likely that the developers will be able to quickly identify the problem without having to ask you for more information. Writing High Quality Bug Reports We encourage users to take extra time to write high-quality bug reports when submitting them. This reduces wasted effort on all sides, as the reporter and the developer who will fix it trade emails until this information is really in place. Eli Goldberg wrote the canonical Bug-Writing Guideline, available at http://issues.apache.org/bugwritinghelp.html. Generally, you'll be well-served by following these guidelines: Include your system information The HelpReport Bug menu choice will fill this in automatically, but if you would prefer not to use this interface, there are several items you need to include in the report. We will need to know what operating system you are using (&Linux;, &MacOS;, or &Windows;), the version of &kde;, and the version of &kmymoney; you're running, and either the version of &MacOS; or &Windows; or the name and version of your &Linux; distribution and the version of your kernel. Include a backtrace for crashes The backtrace is often the single most useful piece of information in solving crashes. Try to reproduce it Let us know if you were able to do so. It's useful to know whether the bug only happened once and you couldn't get it to happen again or happens every time or happens sometimes but not others. Include specific steps This is a bad bug report: I entered a transaction, and &kmymoney; crashed. A much better bug report is: Using the transaction form, I entered a new transaction in my Credit Card account. I selected the Transfer tab, entered in an amount, then changed to the Deposit tab, and back to the Transfer tab. When I returned to the Transfer tab, &kmymoney; crashed. This bug is fully reproducible for me. Tell us what you expected to happen In some cases, this is obvious, but in more subtle bugs, sometimes you'll see a bug report where it is not obvious what the reporter expected to happen. Always tell us what you think should have happened. Consider running with debugging enabled By compiling a version configured with --enable-debug=full you can ensure that the best possible backtraces are generated. If you encounter a crash, run &kmymoney; again from within gdb, and reproduce the crash. When it crashes, type bt to generate a backtrace. Running this way is a bit more difficult, so we don't expect all users to do this. However, if you're interested in helping &kmymoney; become as stable as possible, this is the best way to do it short of finding the bug in the code and sending in a patch.