Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document --appimage-portable-home #36

Open
probonopd opened this issue Sep 15, 2019 · 2 comments
Open

Document --appimage-portable-home #36

probonopd opened this issue Sep 15, 2019 · 2 comments

Comments

@probonopd
Copy link
Member

Document --appimage-portable-home on https://github.com/AppImage/docs.appimage.org/blob/master/source/user-guide/portable-mode.rst.

Show an example using --appimage-portable-home.

Make clear that --appimage-portable-home and --appimage-portable-config are mutually exclusive (one should only use one of them, not both).

Maybe only document --appimage-portable-home because the other one seems to confuse people.

@TheAssassin
Copy link
Member

What are these? Never seen/used these flags. Maybe provide a text, or send a PR?

@probonopd
Copy link
Member Author

probonopd commented Sep 15, 2019

me@host:~$ /isodevice/Applications/appimagetool-x86_64.AppImage --appimage-help
AppImage options:
(...)
  --appimage-portable-home        Create a portable home folder to use as $HOME
  --appimage-portable-config      Create a portable config folder to use as
                                  $XDG_CONFIG_HOME
(...)

Portable home:

  If you would like the application contained inside this AppImage to store its
  data alongside this AppImage rather than in your home directory, then you can
  place a directory named

  /isodevice/Applications/appimagetool-x86_64.AppImage.home

  Or you can invoke this AppImage with the --appimage-portable-home option,
  which will create this directory for you. As long as the directory exists
  and is neither moved nor renamed, the application contained inside this
  AppImage to store its data in this directory rather than in your home
  directory

Note that only --appimage-portable-home is documented extensively, for a reason.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants