environment variable INKSCAPE_PORTABLE_PROFILE_DIR should be documented in man page

Bug #1247448 reported by bcrowell on 2013-11-02
14
This bug affects 2 people
Affects Status Importance Assigned to Milestone
Inkscape
Low
jazzynico
Inkscape-docs
Medium
jazzynico

Bug Description

As usual for a unix man page, Inkscape's has an ENVIRONMENT section that lists the environment variables it uses. The environment variable INKSCAPE_PORTABLE_PROFILE_DIR should be documented there. It doesn't appear to be documented in Inkscape 0.47.

Cf. https://bugs.launchpad.net/inkscape/+bug/382394

I think this environment variable was originally added for a particular pupose (a "portable" version of Inkscape), but it's of interest to any user who is using Inkscape from the command line. For instance, if one uses inkscape to render SVG to PDF from a script, there is no other good way to control the rendering options.

description: updated
description: updated
jazzynico (jazzynico) on 2013-11-03
tags: added: documentation
tags: added: man

We recently ran into this exact issue over on the Unix & Linux Stackoverflow site. It would've saved us a lot of time if this had been clearly documented. One of our senior users to the site finally brought this option to our attention. But only after he had actually offered a patch, giving us the option to override the location of the preferences.xml file, did he later find a thread about the portableapps maintainer wanting this option, did we discover that it even existed.

References
- https://bugs.launchpad.net/inkscape/+bug/382394
- http://unix.stackexchange.com/questions/98503/clean-way-to-temporarily-replace-a-config-file

jazzynico (jazzynico) wrote :

Not sure documenting INKSCAPE_PORTABLE_PROFILE_DIR environment variable is a good idea, since it was requested by the Portable Apps maintainer in order to choose a different Inkscape user preferences directory on Windows. I'd tend to consider it as internal stuff...

An alternative would be to:
* Add the env, renamed to INKSCAPE_PROFILE_DIR, to the man page (but we need to warn the portable apps maintainer of the change).
* Add a new INKSCAPE_PROFILE_DIR in Inkscape and document it in the man page (and keep the portable apps specific env in the code, but not documented in the man).

jazzynico (jazzynico) wrote :

I'm going to add a new INKSCAPE_PROFILE_DIR in Inkscape and document it in the man page, and keep INKSCAPE_PORTABLE_PROFILE_DIR in the code (not documented in the man).

Note that INKSCAPE_PORTABLE_PROFILE_DIR also disables changes to the Windows registry, and thus can't be replaced with the new generic user profile directory env.

Changed in inkscape:
importance: Undecided → Low
milestone: none → 0.91
status: New → In Progress
jazzynico (jazzynico) wrote :

New env committed revision 13346.

jazzynico (jazzynico) wrote :

Man page updated in inkscape-docs, revision 504.

Changed in inkscape:
assignee: nobody → jazzynico (jazzynico)
Changed in inkscape-docs:
assignee: nobody → jazzynico (jazzynico)
importance: Undecided → Medium
status: New → Fix Released
jazzynico (jazzynico) wrote :

POD files updated in the trunk, revision 13347.

Changed in inkscape:
status: In Progress → Fix Committed
jazzynico (jazzynico) on 2015-02-14
Changed in inkscape:
status: Fix Committed → Fix Released
jazzynico (jazzynico) on 2015-08-10
Changed in inkscape-docs:
milestone: none → 0.91
Patrick Storz (ede123) wrote :

If anybody here relies on INKSCAPE_PORTABLE_PROFILE_DIR, please comment on https://gitlab.com/inkscape/inkscape/issues/114, otherwise it will likely be removed.

Patrick Storz (ede123) wrote :

(INKSCAPE_PROFILE_DIR will be kept if there was any doubt)

To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers