Difference between revisions of "Gramps 5.2 Wiki Manual - User Directory"

From Gramps
m (→‎See Also: link to Python Eval)
(Simplify how username is discussed and referred to. Consolidate some duplication in the first section.)
Line 3: Line 3:
 
{{#vardefine:chapter|D}}
 
{{#vardefine:chapter|D}}
 
{{#vardefine:figure|0}}
 
{{#vardefine:figure|0}}
−
This appendix provides the reference for finding the location of the '''Gramps [[Gramps_Glossary#user_directory|User Directory]]'''. The folder/directory is stored at different locations due to the requirements of Gramps forks for various operating systems or special purposes.
+
This appendix documents the location of the '''Gramps [[Gramps_Glossary#user_directory|User Directory]]'''. That directory, or folder, is stored at different locations due to
  
−
{{man note|The location of your '''Gramps user directory''' can depend on the operating system you are using and how you have logged into your computer.|Where '''''<code><~username></code>''''' or '''''<code>%username%</code>''''' is shown below it should be replaced by the name you use to log in to your computer.}}
+
* differences in operating systems
 +
* your username, i.e. the account with which you've logged into your computer. Where <code>username</code> is shown below it should be replaced by your username.
 +
* user configuration
  
 
__TOC__
 
__TOC__
Line 11: Line 13:
 
The default user directory location for Gramps in a [https://wikipedia.org/wiki/Posix POSIX]-style [https://wikipedia.org/wiki/Filesystem_Hierarchy_Standard environment] is:
 
The default user directory location for Gramps in a [https://wikipedia.org/wiki/Posix POSIX]-style [https://wikipedia.org/wiki/Filesystem_Hierarchy_Standard environment] is:
  
−
  /HOME/'''''<username>'''''/.gramps
+
  /home/<code>username</code>/.gramps
 
which can also be entered as
 
which can also be entered as
−
  '''''<~username>'''''/.gramps
+
  ~<code>username</code>/.gramps
  
 
This is true for [https://wikipedia.org/wiki/Bsd BSD], [https://wikipedia.org/wiki/Linux Linux], [https://wikipedia.org/wiki/Solaris_(operating_system) Solaris], [https://wikipedia.org/wiki/Unix Unix] and [https://wikipedia.org/wiki/Mac_OS_X Mac OS-X] when using [[Build_from_source#Mac_OS_X|Mac OS X Build from source]].
 
This is true for [https://wikipedia.org/wiki/Bsd BSD], [https://wikipedia.org/wiki/Linux Linux], [https://wikipedia.org/wiki/Solaris_(operating_system) Solaris], [https://wikipedia.org/wiki/Unix Unix] and [https://wikipedia.org/wiki/Mac_OS_X Mac OS-X] when using [[Build_from_source#Mac_OS_X|Mac OS X Build from source]].
  
−
Alternately, you can leverage the '''$HOME''' [http://www.linfo.org/home_directory.html Home directory equivalent] to avoid dealing the complications of active user names. Although Gramps will not recognize directory equivalents for paths internally, you can use them within Linux to find Gramps user files. The '''Gramps user directory''' path above is simplified to either:
+
Alternately, you can use a tilde or the [http://www.linfo.org/home_directory.html '''$HOME''' environment variable] to avoid referring to the username. Although Gramps will not recognize a tilde or environment variables in paths internally, you can use them within Linux to find Gramps user files. The path above can be simplified to either:
  
−
$HOME/.gramps
 
−
or
 
 
  ~/.gramps
 
  ~/.gramps
−
 
−
Or if using MS Windows the following syntax is used
 
−
 
−
$HOME\.gramps
 
 
or
 
or
−
  ~\.gramps
+
  $HOME/.gramps
  
 
=== macOS ===
 
=== macOS ===
Line 39: Line 35:
 
====macOS Application Package====
 
====macOS Application Package====
 
The [[Mac OS X:Application package]] uses a different, more macOS-standard default location for the directory:
 
The [[Mac OS X:Application package]] uses a different, more macOS-standard default location for the directory:
−
  /Users/'''''<~username>'''''/Library/Application Support/gramps
+
  /Users/<code>username</code>/Library/Application Support/gramps
  
 
== MS Windows ==
 
== MS Windows ==
Line 47: Line 43:
  
 
The default '''User Directory''' location for any Gramps user data on a Windows 7 (and newer) system is  
 
The default '''User Directory''' location for any Gramps user data on a Windows 7 (and newer) system is  
−
  C:\Users\'''''%username%'''''\AppData\Local\gramps
+
  C:\Users\<code>username</code>\AppData\Local\gramps
−
 
 
−
The '''''%username%''''' in the above filepath is a placeholder for the particular user name chosen when logging into Windows.
 
  
−
Alternately, you can leverage the '''%LocalAppData%''' [https://wikipedia.org/wiki/Environment_variable#APPDATA environment variable] to avoid dealing the complications of active user names. (We've chosen to use the username Environment Variable in the documentation for Windows rather than '''''<~username>''''' used for documenting other OSes.) Although Gramps will not recognize Environment Variables for paths internally, you can use them within Windows to find Gramps user files. The '''Gramps user directory''' path above is simplified to:
+
Alternately, you can use the '''%LocalAppData%''' [https://wikipedia.org/wiki/Environment_variable#APPDATA environment variable] to avoid referring to the username. (We've chosen to use the username environment variable in the documentation for Windows rather than '''''<~username>''''' used for documenting other OSes.) Although Gramps will not recognize environment variables for paths internally, you can use them within Windows to find Gramps user files. The path above can be simplified to:
 
  %LocalAppData%\gramps
 
  %LocalAppData%\gramps
 
{{man note|User Directory relocated {{new|5.2.0}}|'''The User Directory has relocated in version 5.2'''<br />The default '''User Directory''' location for the 5.2 version of Gramps user data on a Windows 7 (and newer) system is: <br />&nbsp;<code> C:\Users\'''''%username%'''''\AppData\Local\gramps</code><br />&nbsp;<code> %LocalAppData%\gramps</code><br />The default '''User Directory''' location for any 5.1.x and earlier version of Gramps user data on a Windows 7 (and newer) system is: <br />&nbsp;<code> C:\Users\'''''%username%'''''\AppData\Roaming\gramps</code><br />&nbsp;<code> %AppData%\gramps</code>}}
 
{{man note|User Directory relocated {{new|5.2.0}}|'''The User Directory has relocated in version 5.2'''<br />The default '''User Directory''' location for the 5.2 version of Gramps user data on a Windows 7 (and newer) system is: <br />&nbsp;<code> C:\Users\'''''%username%'''''\AppData\Local\gramps</code><br />&nbsp;<code> %LocalAppData%\gramps</code><br />The default '''User Directory''' location for any 5.1.x and earlier version of Gramps user data on a Windows 7 (and newer) system is: <br />&nbsp;<code> C:\Users\'''''%username%'''''\AppData\Roaming\gramps</code><br />&nbsp;<code> %AppData%\gramps</code>}}

Revision as of 15:40, 8 September 2024

Previous Index Next
Gramps-config-language.png Languages: 

English  • Deutsch  • español  • suomi  • français  • עברית  • македонски  • Nederlands  • русский  • shqip  • slovenčina


This appendix documents the location of the Gramps User Directory. That directory, or folder, is stored at different locations due to

  • differences in operating systems
  • your username, i.e. the account with which you've logged into your computer. Where username is shown below it should be replaced by your username.
  • user configuration

POSIX - style systems

The default user directory location for Gramps in a POSIX-style environment is: 

/home/username/.gramps

which can also be entered as 

~username/.gramps

This is true for BSD, Linux, Solaris, Unix and Mac OS-X when using Mac OS X Build from source.

Alternately, you can use a tilde or the $HOME environment variable to avoid referring to the username. Although Gramps will not recognize a tilde or environment variables in paths internally, you can use them within Linux to find Gramps user files. The path above can be simplified to either: 

~/.gramps

or 

$HOME/.gramps

macOS

Macos 200x200.png

On Apple Macs filenames starting with "." do not show up in Finder. To simplify access to the Gramps user directory, open a terminal window using the Terminal application and type: 

ln -s ~/.gramps ~/Documents/Gramps

which will make Finder show the directory as a folder in your Documents folder named "Gramps". (You can replace "Gramps" with whatever name you wish, but use a / before any spaces.) Alternatively you can simply click on Go -> 'Go to Folder...' in the Finder, and type 

~/.gramps

in the resulting macOS Go to the Folder dialog box.

macOS Application Package

The Mac OS X:Application package uses a different, more macOS-standard default location for the directory: 

/Users/username/Library/Application Support/gramps

MS Windows

Windows 180x160.png

On Microsoft Windows, filenames and folder for programs and userdata are hidden in the File Explorer. To make access to the Gramps user directory easy follow the following advice from Microsoft:


The default User Directory location for any Gramps user data on a Windows 7 (and newer) system is 

C:\Users\username\AppData\Local\gramps

Alternately, you can use the %LocalAppData% environment variable to avoid referring to the username. (We've chosen to use the username environment variable in the documentation for Windows rather than <~username> used for documenting other OSes.) Although Gramps will not recognize environment variables for paths internally, you can use them within Windows to find Gramps user files. The path above can be simplified to: 

%LocalAppData%\gramps
Gramps-notes.png
User Directory relocated — ⚡new for version 5.2.0

The User Directory has relocated in version 5.2
The default User Directory location for the 5.2 version of Gramps user data on a Windows 7 (and newer) system is:
  C:\Users\%username%\AppData\Local\gramps
  %LocalAppData%\gramps
The default User Directory location for any 5.1.x and earlier version of Gramps user data on a Windows 7 (and newer) system is:
  C:\Users\%username%\AppData\Roaming\gramps
  %AppData%\gramps

Like the User Directory, the location for programs/applications is also hidden from browsing with Windows Explorer.

The default location for an installation on a Windows 7 (and newer) system is 

C:\Program Files\GrampsAIO64-5.X.X


See Also

Previous Index Next
Gramps-config-language.png Languages: 

English  • Deutsch  • español  • suomi  • français  • עברית  • македонски  • Nederlands  • русский  • shqip  • slovenčina

Gnome-important.png Special copyright notice: All edits to this page need to be under two different copyright licenses:

These licenses allow the Gramps project to maximally use this wiki manual as free content in future Gramps versions. If you do not agree with this dual license, then do not edit this page. You may only link to other pages within the wiki which fall only under the GFDL license via external links (using the syntax: [https://www.gramps-project.org/...]), not via internal links.
Also, only use the known Typographical conventions

Retrieved from "https://www.gramps-project.org/wiki/index.php?title=Gramps_5.2_Wiki_Manual_-_User_Directory&oldid=105120"