Man page draft for 1.3.x: Difference between revisions
(Added man page draft (Craig Ringer's man page))
No edit summary
|Line 147:||Line 147:|
Updated 2004-09-27 scribus(1)
Updated 2004-09-27 scribus(1)
Revision as of 11:45, 21 April 2005
This draft is meant to follow closely the current Scribus development, feel free to add your remarks and update it (provided, you know, what you are writing about :). Translators who want to create a man page in their language based on this draft should read our howto on creating Scribus man pages first.
Man page draft
scribus - open source X11-based WYSIWYG desktop publishing app
scribus [-h|--help] [-v|--version] [-l|--lang language] [-la|--langs- available] [-f|--file|--] [filename]
Scribus is an open source desktop publishing program. It provides true WYSIWYG editing, excellent PDF export facilities, and a wide range of other input and output options.
Please see the scribus documentation at http://docs.scribus.net/ or the program's built in help for more comprehensive and up-to-date doc- umentation.
This man page only provides summaries of some aspects of the program's use. It's main purpose is to make sure you can find the full documen- tation quickly and easily.
The definitive options are in the program's usage statement. Run: scribus --help to view the usage statement.
-l, --lang xx Overrides the system locale and runs Scribus in language xx. The language is specified with the same POSIX language codes that are used in the LANG and LC_ALL environment variables. For example, English can be selected with 'en' (generic English), 'en_GB' (British English), 'en_US' (American english), etc. Similarly, Deutsch can be selected with 'de' or 'de_DE'.
-la, --langs-available Print a list of languages for which user interface translations are available. To use that language run Scribus as 'scribus -l xx' where xx is the short language code, or set the locale environment variables as described below.
-v, --version Prints the Scribus version number and exits.
-f, --file Open the specified file. It's possible to simply pass the file name as an unqualified argument instead of using this, though if the name begins with a - you will need to use --, eg 'scribus -- -myfile.sla'.
-h, --help Print a brief usage summary.
Scribus respects the standard locale environment variables. Others may be used through underlying libraries, such as Qt, or by programs used by Scribus. http://docs.scribus.net/ and the in-program documentation may note other environment variables used by Scribus or the programs and libraries it uses.
LC_ALL, LC_MESSAGES, LANG POSIX locale. See locale(1). Scribus uses these three environ- ment variables, in the listed order of precedence, to select the language (including the user interface translation) to use. If none are set, it will fall back on the locale set by the underlying Qt library.
PATH Scribus may search the PATH for external tools if their paths are not specified absolutely. This is currently most likely to affect you if you have multiple copies of gs(1) installed. You can set an absolute path to the correct gs(1) in your Scribus preferences and bypass the PATH search.
A few important environment variables from other programs are sum- marised here for convenience, though you should check the original program's documentation if you are having trouble.
GS_FONTPATH GhostScript font path. Affects the font search path for GhostScript, a component Scribus uses for some PostScript oper- ations. Add new directories containing fonts to this colon-sep- arated list to help GhostScript find fonts in non-standard locations. See gs(1) and the GhostScript HTML documentation for more information.
GS_LIB GhostScript library path. GhostScript searches this path for Fontmap files. Like GS_FONTPATH it's a colon separated list of directories. You will usually want to use GS_FONTPATH instead, though building a Fontmap file and using GS_LIB can speed things up if you have a lot of fonts. See gs(1) and the GhostScript HTML documentation for more information.
$HOME/.scribus/ User preferences are stored in $HOME/.scribus/ . Most other paths are configurable from the Scribus preferences. $HOME/.scribus/scribus.rc Scribus preferences file - formatted in a custom xml schema. May eventually be retired in favour of new format prefs file. $HOME/.scribus/prefs.xml New format prefs file. As of time of writing (v1.2.x) this file was mostly unused. Configuration files for related programs:
/etc/fonts Fontconfig, the library used by Scribus to locate fonts, is normally configured with files in /etc/fonts, mainly /etc/fonts/fonts.conf and /etc/fonts/local.conf . It may also use a config file in $HOME/.fonts/ . See fonts.conf(5) and the fontconfig documentation for more information. Note that Scribus may also use its internal font path to locate more fonts - see the Preferences dialog and scribus help.
The scribus documentation site http://docs.scribus.net/ and home page http://www.scribus.net/
gs(1), the gs html docs, and http://www.ghostscript.com/
The Qt library - http://www.trolltech.com/
fonts-conf(5) for info on configuring FontConfig
RELATED SOFTWARE AND AFFILIATES
inkscape(1) - http://inkscape.org/
OpenClipArt - http://openclipart.org/
Other affiliates may be listed in the footer on http://www.scribus.net/
gimp(1) - http://www.gimp.org/
See http://bugs.scribus.net/ for the Scribus on-line status tracker, which is used to track bug reports and feature requests. If you intend to submit a bug report or feature request, please search the bug database first.
Please see the About Scribus option in the Help menu for a list of authors, translators, and contributors.
Updated 2004-09-27 scribus(1)
- Note as an exception to the general CC license the wiki is using, this man file is licensed under GPL V.2, as are the main source licenses.--Mrdocs 11:45, 21 Apr 2005 (UTC)