Skip to content
This repository has been archived by the owner on Oct 10, 2019. It is now read-only.

Commit

Permalink
Document how to migrate to XDG base directories (#39)
Browse files Browse the repository at this point in the history
  • Loading branch information
Minoru committed Oct 25, 2016
1 parent ecaaf8c commit fb74067
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 9 deletions.
29 changes: 27 additions & 2 deletions doc/manpage-newsbeuter.txt
Original file line number Diff line number Diff line change
Expand Up @@ -129,12 +129,37 @@ include::chapter-cmdline.txt[]
Jump to the <number>th entry in the current dialog


XDG Base Directory Support
--------------------------

Newsbeuter defaults to storing everything in '$HOME/.newsbeuter' directory. If
you prefer XDG, create '$HOME/.config/newsbeuter' and
'$HOME/.local/share/newsbeuter' directories, and Newsbeuter will use them
from there on.

If you already have some files in '$HOME/.newsbeuter/', move them as follows:

'config', 'urls'::
to '$HOME/.config/newsbeuter/'

'cache.db', 'history.search', 'history.cmdline'::
to '$HOME/.local/share/newsbeuter/'

See also a corresponding section in podbeuter(1).


FILES
-----

'$HOME/.newsbeuter/config'
dotfiles::
'$HOME/.newsbeuter/config'
+
'$HOME/.newsbeuter/urls'

'$HOME/.newsbeuter/urls'
XDG::
'$HOME/.config/newsbeuter/config'
+
'$HOME/.config/newsbeuter/urls'


SEE ALSO
Expand Down
24 changes: 22 additions & 2 deletions doc/manpage-podbeuter.txt
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,32 @@ CONFIGURATION COMMANDS
include::podbeuter-cfgcmds.txt[]


XDG Base Directory Support
--------------------------

Podbeuter defaults to storing everything in '$HOME/.newsbeuter' directory. If
you prefer XDG, create '$HOME/.config/newsbeuter' and
'$HOME/.local/share/newsbeuter' directories, and Podbeuter will use them from
there on.

If you already have some files in '$HOME/.newsbeuter/', move the 'queue' file to
'$HOME/.local/share/newsbeuter/', and that should be it.

See also a corresponding section in newsbeuter(1).


FILES
-----

'$HOME/.newsbeuter/config'
dotfiles::
'$HOME/.newsbeuter/config'
+
'$HOME/.newsbeuter/urls'

'$HOME/.newsbeuter/queue'
XDG::
'$HOME/.config/newsbeuter/config'
+
'$HOME/.config/newsbeuter/urls'


SEE ALSO
Expand Down
19 changes: 14 additions & 5 deletions doc/newsbeuter.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1013,12 +1013,21 @@ http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html[XDG Base
Directory Specification]. It needs to be set up manually by creating the
following directories:

~/.local/share/newsbeuter/
~/.config/newsbeuter/
'~/.local/share/newsbeuter/'
'~/.config/newsbeuter/'

If these directories exist or the environment variables $XDG_CONFIG_HOME and
$XDG_DATA_HOME are set, newsbeuter will use these directories, otherwise it
will default to ~/.newsbeuter as its configuration directory.
If these directories exist or the environment variables `$XDG_CONFIG_HOME` and
`$XDG_DATA_HOME` are set, newsbeuter will use these directories, otherwise it
will default to '~/.newsbeuter' as its configuration directory.

If you're currently using '~/.newsbeuter/' but wish to migrate to XDG
directories, you should move the files as follows:

'config', 'urls'::
to '$HOME/.config/newsbeuter/'

'cache.db', 'history.search', 'history.cmdline', 'queue'::
to '$HOME/.local/share/newsbeuter/'


Podcast Support
Expand Down

0 comments on commit fb74067

Please sign in to comment.