Difference between revisions of "GnuCash"

From GnuCash
Jump to: navigation, search
(Documentation: structure specific topics; new: Trading Accounts)
(Historical Information: Remove obsolete link to deleted page)
(32 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__
+
{| class="wikitable" style="margin: auto;"
GnuCash is the leading GPL'ed Desktop Financial Manager Application.  Appropriate for personal and small business use, it is meant to be easy to use and full of features.
+
! scope="row"|Languages
 +
| [[de/GnuCash|Deutsch]]
 +
| [[es/GnuCash|Español]]
 +
| [[pt/GnuCash|Português]]
 +
|}
 +
GnuCash is the leading [http://www.gnu.org/licenses/ GPL'ed] Desktop Financial Manager Application.  Appropriate for personal and small business use, it is meant to be easy to use and full of features.
 +
{| class="wikitable" style="margin: auto;"
 +
| There is no registration required to read this wiki or [http://www.gnucash.org/download.phtml download] and [[#Installation|install GnuCash]], only to edit this wiki.
 +
|}
  
== Translation ==
+
== Installation ==
 +
GnuCash has versions that run on '''Windows''', '''MacOS''', and many different flavors of '''Linux''' and '''BSD'''.
  
(Parts of) this wiki have been translated into other languages or contain information for one specific language only. These are the index pages for these language dependent sections:
+
Installation instructions for the different operating systems under which GnuCash operates are included at [[Installation]].
  
* [[de/GnuCash]] Deutsche Wiki-Seiten, im Entstehen (German pages, work in progress)
+
== Getting Help ==
* [[pt/GnuCash]] Sítio Wiki em Português, em andamento. (Portuguese Wiki site, work in progress)
+
If you have trouble using GnuCash, and the various documentation sources haven't helped you--or if you want to give some feedback, you can get help in several ways. See [[Getting Help]] for these options.
  
== Documentation ==
+
== Available Documentation ==
* The [[Glossary]] explains some often used terms.
+
=== Documentation for Users ===
* The [[FAQ|GnuCash FAQ]] contains the collection of all frequently asked questions about GnuCash, including administration, accounting, and glossary questions.
+
GnuCash offers two primary instructional documents:
* Read the online copy of the [http://www.gnucash.org/docs/ released documentation] and the [http://svn.gnucash.org/docs/ most recent, unstable SVN versions].
+
* [http://www.gnucash.org/viewdoc.phtml?doc=help ''The Help Manual'']—reference for details of operating specific GnuCash menus, dialogs, and windows, and
* [[Documentation|List to external international documentation]] and a somewhat outdated list of [http://www.gnucash.org/docs.phtml available online documentation]
+
* [http://www.gnucash.org/viewdoc.phtml?doc=guide ''The Tutorial and Concepts Guide'']—a concise introduction to double-entry accounting and tutorials on using GnuCash to perform a variety of accounting tasks. It is highly recommended that new users read at least the '''Getting Started''' section of the ''Guide''.
* [[GnuCash Quick Start Guide For Business Users]]. Also, business users might be interested in a book by PacktPub, UK: [http://link.packtpub.com/6FDDUr GnuCash 2.4 Small Business Accounting, by Ashok Ramachandran]
+
These are accessible via the '''Help''' menu in the program (if you've installed via a package manager you may need to install an additional package called something like "gnucash-docs") and from the [http://www.gnucash.org/docs.phtml Documentation page on the gnucash.org ''website''].
* [[Using GnuCash]] collects real life experiences with GnuCash. You may find (user) solutions here that are not covered by the documentation.
+
The ''Help Manual'' is available in English, German, Italian, and Japanese; the ''Guide'' in English, Italian, Japanese, Portuguese, and Russian.
* Some more specific topics:
 
** "Normal" Usage
 
***[[Keyboard Shortcuts]]
 
*** Using [[Scheduled Transactions]]
 
*** Online Banking: [[Setting up OFXDirectConnect in GnuCash 2]] and [[AqBanking]] (FinTS/HBCI)
 
*** [[Trading Accounts]] (New since 2.3.8/2.4.0)
 
** Scripting and Programming:
 
*** How to create some [[Custom Reports]]
 
*** [[Python Bindings]]
 
*** Notes about the [[C API]]
 
*** The [http://cvs.gnucash.org/docs/HEAD/ GnuCash API]
 
** Error Seaching:
 
*** [[Logging]] messages and filtering detail.
 
*** Getting a [[Stack Trace]]
 
** OS specific:
 
*** [[MacOSXReadme| Mac OS X Release Notes]]
 
  
=== Installation ===
+
''PDF'', ''ePub'', and ''mobi'' formats may be downloaded from the [http://www.gnucash.org/docs.phtml Documentation page] where you will also find the documentation for earlier releases and a nightly build of changes made since the last release.
OS/Distro specific annotations:
 
* [[FreeBSD]]
 
* [[MacOSXInstallation]] and [[MacOSX/Quartz]]
 
* Linux
 
** [[Debian]], [http://packages.debian.org/search?suite=default&section=all&arch=any&searchon=names&keywords=gnucash Debian packages]
 
** [[Gentoo]]
 
** [[Mandriva]]
 
** [[RedHat]]: FC5, RHEL4, CentOS4.3, RHEL5 / SL5.
 
** [[SuSE]]
 
** [[Slackware]]
 
** [[Ubuntu]]
 
* [[Solaris]]
 
* [[Windows|Microsoft Windows]]: GnuCash runs on Windows as well. Download the binary package from [http://sourceforge.net/project/showfiles.php?group_id=192 sourceforge.net].
 
  
== Support ==
+
'''The GnuCash wiki''' includes extensive information regarding all aspects of GnuCash, contributed by the developers and users of GnuCash. Information in the wiki covers a broad variety of topics, and includes detailed technical information, as well as information that applies to specific use cases. Of particular interest on the wiki are:
 +
* The [[FAQ|GnuCash FAQ]], which contains a collection of frequently asked questions about GnuCash, including administration, accounting, and glossary questions, and
 +
* [[Using GnuCash]], which collects real life experiences using GnuCash. You may find (user) solutions here that are not covered by the documentation.
  
If you read the relevant parts of the pages above and still stuck with a problem or only wish to give some feedback, you can contact us in several ways:
+
=== Documentation for Developers ===
 +
The Application programming interface (API) for people who want to use the gnucash engine in their own project:
 +
* [http://code.gnucash.org/docs/MAINT maint], the stable branch and
 +
* [http://code.gnucash.org/docs/MASTER master], the new feature branch, which are daily generated from the sources using [[Doxygen]].
  
=== Current discussion ===
+
[[Using the API]] shows how to use it.
# [[IRC]] chat, usually in english, is the quickest way;
 
# a bunch of [[Mailing Lists]] for discussions in different languages;
 
  
=== 3. party tools ===
+
== Getting involved in the GnuCash project ==
Several users [[published tools]] to work with Gnucash.
+
The GnuCash Project is a volunteer-driven organization. We need your help to ensure that GnuCash survives and grows, and we need your help to help others.  
  
=== Feature request and bug tracking ===
+
There are many ways to contribute your knowledge and experience. Before you dig in, you may want to check out the [http://www.gnucash.org GnuCash website] for the latest news.
# [[Bugzilla]] bug database for error reports and enhancement requests;
 
# [http://gnucash.uservoice.com "Uservoice" Feature Request Forum].
 
  
This will also influence the
+
'''Note:''' This part of the wiki is intended to become the main repository of GnuCash developer documentation. Some formerly static pages have been moved here from the [http://www.gnucash.org GnuCash website], but the move is not yet complete. Some remaining static pages may be out of date. Wherever a wiki article disagrees with a static web page on the Website, the wiki article here is more likely to be correct.
  
== Further Development ==
+
Here are a number of ways to get involved.
  
You may also want to check out http://www.gnucash.org/ for the latest news.
+
=== Mailing Lists ===
 +
Subscribing to the mailing lists, and asking and answering questions there, is an excellent way to begin contributing the the success of GnuCash. See [[Mailing Lists]] for more.
  
This part of the wiki is intended to become the main repository of GnuCash developer documentation. Some formerly static pages have been moved here from the Website http://www.gnucash.org, but the move is not yet complete. Some remaining static pages may be out of date. Wherever a wiki article disagrees with a static web page on the Website, the wiki article here is more likely to be correct.
+
=== Filing Bugs and Enhancement Requests ===
 +
Occasionally, GnuCash will not work the way it was designed to work--or you have an idea for making GnuCash better. Improvements and fixes can be submitted using the [[Bugzilla]] bug tracker; more general suggestions can be made via the [http://gnucash.uservoice.com Uservoice] pages.
  
=== Getting involved in the project ===
+
=== Improving the Documentation ===
* How to get involved in [[Development]] - not only for programmers ...
+
* [[Documentation Update Instructions]]. This page describes the process to change both the GnuCash Tutorial and Concepts Guide and the Help Manual.
* [[Documentation Update Instructions]] describe the process to change both the GnuCash "Guideand the GnuCash "Help" manuals as well as any other parts of GnuCash documentation.
+
 
* How to edit and improve the [[Translation]]s, but please keep an eye on the [[Translation Status]].
+
=== Localization ===
* How to improve or add new [[Account Hierarchy Template]]s.
+
* [[Translation|Translations]] gives an overview of this process, but please keep an eye on the [[Translation Status]].
* Reminders for the [[Project Administration]]
+
* How to adjust or create new [[Account Hierarchy Template]]s.
* [[GSoC]] Google Summer of Code
 
  
=== Current Source Code ===
+
=== Developing the Application Code ===
* [[Subversion]] access
+
==== Policy ====
 
* Our [[Development Process]]
 
* Our [[Development Process]]
* [[Building]] GnuCash from source code.
 
* The [http://svn.gnucash.org/docs/HEAD/ Doxygen] source documentation system and its  [[Doxygen|wiki page]].
 
 
* [[CodingStandard | Coding Standards]]
 
* [[CodingStandard | Coding Standards]]
 
* [[Testing]]
 
* [[Testing]]
 +
 +
==== Procedures ====
 +
* [[Git]] access
 +
* [[Building]] GnuCash from source code.
 
* Some notes about the [[GnuCash XML format]] for the XML Backend.
 
* Some notes about the [[GnuCash XML format]] for the XML Backend.
 
* The schema for the [[SQL]] Backend.
 
* The schema for the [[SQL]] Backend.
 +
* [[Adding Preferences]]: How to add new preferences.
 +
* Creating [[Custom Reports]]
 +
* [[Python Bindings]]
 +
 +
==== Other Development Notes ====
 +
* Reminders for the [[Project Administration]]
  
=== Future developments ===
+
==== Future developments ====
 
* Our [[Release Schedule]]
 
* Our [[Release Schedule]]
 
* Future [[Roadmap]]
 
* Future [[Roadmap]]
* A general edited list of requested enhancements: [[WishList]]
+
 
* Particular enhancements:
+
==== Historical Information ====
** [[Concept Guide]]
+
* Outdated [[WishList]]
** [[Budgets]]
+
* [[Budget History]]
** [[Clickable Reports UI]]
+
* [[Credit Notes]]
** [[Credit Notes]]
 
 
* [[Old discussions]] about enhancement requests that have been implemented.
 
* [[Old discussions]] about enhancement requests that have been implemented.
** [[Upgrade from 1.8.9 to 1.8.10 and HBCI online banking support]]
 
 
* Discussion about the [[License]]
 
* Discussion about the [[License]]
----
+
* Special events
The GnuCash Project is a volunteer-driven organization. We need your help to survive and grow, to help others and to help the Project.
+
** There was a [[Bounty Program]] in June / July 2013
 +
** [[GSoC]] Google Summer of Code

Revision as of 10:58, 13 October 2018

Languages Deutsch Español Português

GnuCash is the leading GPL'ed Desktop Financial Manager Application. Appropriate for personal and small business use, it is meant to be easy to use and full of features.

There is no registration required to read this wiki or download and install GnuCash, only to edit this wiki.

Installation

GnuCash has versions that run on Windows, MacOS, and many different flavors of Linux and BSD.

Installation instructions for the different operating systems under which GnuCash operates are included at Installation.

Getting Help

If you have trouble using GnuCash, and the various documentation sources haven't helped you--or if you want to give some feedback, you can get help in several ways. See Getting Help for these options.

Available Documentation

Documentation for Users

GnuCash offers two primary instructional documents:

  • The Help Manual—reference for details of operating specific GnuCash menus, dialogs, and windows, and
  • The Tutorial and Concepts Guide—a concise introduction to double-entry accounting and tutorials on using GnuCash to perform a variety of accounting tasks. It is highly recommended that new users read at least the Getting Started section of the Guide.

These are accessible via the Help menu in the program (if you've installed via a package manager you may need to install an additional package called something like "gnucash-docs") and from the Documentation page on the gnucash.org website. The Help Manual is available in English, German, Italian, and Japanese; the Guide in English, Italian, Japanese, Portuguese, and Russian.

PDF, ePub, and mobi formats may be downloaded from the Documentation page where you will also find the documentation for earlier releases and a nightly build of changes made since the last release.

The GnuCash wiki includes extensive information regarding all aspects of GnuCash, contributed by the developers and users of GnuCash. Information in the wiki covers a broad variety of topics, and includes detailed technical information, as well as information that applies to specific use cases. Of particular interest on the wiki are:

  • The GnuCash FAQ, which contains a collection of frequently asked questions about GnuCash, including administration, accounting, and glossary questions, and
  • Using GnuCash, which collects real life experiences using GnuCash. You may find (user) solutions here that are not covered by the documentation.

Documentation for Developers

The Application programming interface (API) for people who want to use the gnucash engine in their own project:

  • maint, the stable branch and
  • master, the new feature branch, which are daily generated from the sources using Doxygen.

Using the API shows how to use it.

Getting involved in the GnuCash project

The GnuCash Project is a volunteer-driven organization. We need your help to ensure that GnuCash survives and grows, and we need your help to help others.

There are many ways to contribute your knowledge and experience. Before you dig in, you may want to check out the GnuCash website for the latest news.

Note: This part of the wiki is intended to become the main repository of GnuCash developer documentation. Some formerly static pages have been moved here from the GnuCash website, but the move is not yet complete. Some remaining static pages may be out of date. Wherever a wiki article disagrees with a static web page on the Website, the wiki article here is more likely to be correct.

Here are a number of ways to get involved.

Mailing Lists

Subscribing to the mailing lists, and asking and answering questions there, is an excellent way to begin contributing the the success of GnuCash. See Mailing Lists for more.

Filing Bugs and Enhancement Requests

Occasionally, GnuCash will not work the way it was designed to work--or you have an idea for making GnuCash better. Improvements and fixes can be submitted using the Bugzilla bug tracker; more general suggestions can be made via the Uservoice pages.

Improving the Documentation

Localization

Developing the Application Code

Policy

Procedures

Other Development Notes

Future developments

Historical Information