Difference between revisions of "Plugins Command Line"

From Gramps
Jump to: navigation, search
m
m (Generate Testcases for Persons and Families)
 
(15 intermediate revisions by 5 users not shown)
Line 1: Line 1:
[[Category:Documentation]][[Category:Plugins]]
+
{{stub}}<!--need to merge into relevant user manual-->
 +
Available options to use from the command line for reports and tools.
  
This page lists available options on command line for reports and tools.
+
In general the process of learning about a command line option is easy.
 +
 
 +
First, learn the name of all the reports or tools:
 +
gramps -O "My Family Tree" -a report
 +
gramps -O "My Family Tree" -a tool
 +
 
 +
Second, learn all the options of the particular report or tool.
 +
gramps -O "My Family Tree" -a report -p name=a_report,show=all
 +
gramps -O "My Family Tree" -a tool -p name=a_tool,show=all
 +
 
 +
Third, learn what a particular option is.
 +
gramps -O "My Family Tree" -a report -p name=a_report,show=some_option
 +
gramps -O "My Family Tree" -a tool -p name=a_tool,show=some_option
 +
 
 +
See [[Gramps_5.1_Wiki_Manual_-_Command_Line#report_action_option|Command Line]] for more information.
  
 
==Reports==
 
==Reports==
 
 
===Common Options===
 
===Common Options===
  
Line 10: Line 24:
  
 
The center person for the filter
 
The center person for the filter
 
I4 Smith, Ingeman
 
  
 
I18 Smith, John Hjalmar
 
I18 Smith, John Hjalmar
  
I38 Hansdotter, Kerstina
+
*callname:
  
I39 Smith, Martin
+
0 Don't use call name
  
I28 Streiffert, Anna
+
1 Replace first name with call name
  
I40 Smith, Marjorie Alice
+
2 Underline call name in first name / add call name to first name
  
I22 Smith, Martin
+
*person_youngestmarried:
  
I11 Smith, Hanna
+
0 no
  
I41 Green, Janis Elaine
+
1 yes
  
I15 Smith, Gus
+
*person_youngestdivorced:
  
I8 Smith, Hjalmar
+
0 no
  
I3 Smith, Magnes
+
1 yes
  
I5 Smith, Mason Michael
+
*style: =name
  
I10 Smith, Hans Peter
+
Style name.
  
I24 Smith, Gustaf Sr.
+
Value: ''''
  
I20 Smith, Carl Emil
+
*family_youngestmarried:
  
I17 Jones, Lillie Harriet
+
0 no
  
I23 Smith, Astrid Shermanna Augusta
+
1 yes
  
I1 Smith, Keith Lloyd
+
*person_oldestmother:
  
I37 Smith, Edwin Michael
+
0 no
  
I19 Smith, Eric Lloyd
+
1 yes
  
I25 Ericsdotter, Marta
+
*papero: =num
  
I29 Smith, Craig Peter
+
Paper orientation number.
  
I2 Smith, Amber Marie
+
Value: ''''
  
I33 Smith, Lloyd
+
*person_oldestdivorced:
  
I32 Horne, Darcy
+
0 no
  
I26 Smith, Kirsti Marie
+
1 yes
  
I35 Smith, Lars Peter
+
*person_youngestfather:
  
I30 Adams, Janice Ann
+
0 no
  
I0 Hansdotter, Anna
+
1 yes
  
I31 Ohman, Marjorie
+
*template: =name
  
I12 Nielsen, Herman Julius
+
Template name (HTML only).
  
I9 Smith, Emil
+
Value: ''''
  
I27 Smith, Ingeman
+
*papers: =name
  
I36 Jefferson, Elna
+
Paper size name.
  
I21 Smith, Hjalmar
+
Value: ''''
  
I34 Perkins, Alice Paula
+
*person_youngestliving:
  
I14 Smith, Marjorie Lee
+
0 no
  
I7 Smith, Ingar
+
1 yes
  
I6 Willard, Edwin
+
*family_longest:
  
I16 Anderson, Jennifer
+
0 no
  
I13 Michaels, Evelyn
+
1 yes
  
*callname:
+
*person_oldestliving:
  
0 Don't use call name
+
0 no
  
1 Replace first name with call name
+
1 yes
  
2 Underline call name in first name / add call name to first name
+
*person_oldestfather:
 
 
*person_youngestmarried:
 
  
 
0 no
 
0 no
Line 109: Line 119:
 
1 yes
 
1 yes
  
*person_youngestdivorced:
+
*family_mostchildren:
  
 
0 no
 
0 no
Line 115: Line 125:
 
1 yes
 
1 yes
  
*style: =name
+
*family_oldestmarried:
  
Style name.
+
0 no
  
Value: ''''
+
1 yes
  
*family_youngestmarried:
+
*person_oldestmarried:
  
 
0 no
 
0 no
Line 127: Line 137:
 
1 yes
 
1 yes
  
*person_oldestmother:
+
*off: =format
  
0 no
+
Output file format.
  
1 yes
+
Value: ''''
  
*papero: =num
+
*of: =filename
  
Paper orientation number.
+
Output file name. MANDATORY
  
 
Value: ''''
 
Value: ''''
  
*person_oldestdivorced:
+
*person_oldestdied:
  
 
0 no
 
0 no
Line 145: Line 155:
 
1 yes
 
1 yes
  
*person_youngestfather:
+
*person_youngestmother:
  
 
0 no
 
0 no
Line 151: Line 161:
 
1 yes
 
1 yes
  
*template: =name
+
*filter:
  
Template name (HTML only).
+
Determines what people are included in the report
  
Value: ''''
+
0 Entire Database
  
*papers: =name
+
1 Descendants of Smith, Edwin Michael
  
Paper size name.
+
2 Descendant Families of Smith, Edwin Michael
  
Value: ''''
+
3 Ancestors of Smith, Edwin Michael
  
*person_youngestliving:
+
4 People with common ancestor with Smith, Edwin Michael
 +
 
 +
*family_shortest:
  
 
0 no
 
0 no
Line 169: Line 181:
 
1 yes
 
1 yes
  
*family_longest:
+
*person_youngestdied:
  
 
0 no
 
0 no
  
 
1 yes
 
1 yes
 +
===Records Report===
  
*person_oldestliving:
+
*name:
  
0 no
+
records
  
1 yes
+
*family_longest:
  
*person_oldestfather:
 
  
0 no
+
*family_youngestmarried:
  
1 yes
 
  
 
*family_mostchildren:
 
*family_mostchildren:
  
0 no
 
  
1 yes
+
*person_oldestmother:
  
*family_oldestmarried:
 
  
0 no
+
*person_oldestmarried:
  
1 yes
 
  
*person_oldestmarried:
+
*person_oldestdivorced:
  
0 no
 
  
1 yes
+
*person_oldestfather:
  
*off: =format
 
  
Output file format.
+
*person_oldestdied:
  
Value: ''''
 
  
*of: =filename
+
*person_youngestmother:
  
Output file name. MANDATORY
 
  
Value: ''''
+
*filter:
  
*person_oldestdied:
+
Determines what people are included in the report
  
0 no
+
*person_youngestfather:
  
1 yes
 
  
*person_youngestmother:
+
*pid:
  
0 no
+
The center person for the filter
  
1 yes
+
*person_oldestliving:
  
*filter:
 
  
Determines what people are included in the report
+
*person_youngestliving:
  
0 Entire Database
 
  
1 Descendants of Smith, Edwin Michael
+
*callname:
  
2 Descendant Families of Smith, Edwin Michael
 
  
3 Ancestors of Smith, Edwin Michael
+
*family_shortest:
  
4 People with common ancestor with Smith, Edwin Michael
 
  
*family_shortest:
+
*person_youngestdivorced:
  
0 no
 
  
1 yes
+
*person_youngestmarried:
  
*person_youngestdied:
 
  
0 no
+
*family_oldestmarried:
  
1 yes
 
===Records Report===
 
  
*name:
+
*person_youngestdied:
  
records
+
===Common Options===
  
*family_longest:
+
*bookname: =name
  
 +
Name of the book. MANDATORY
 +
===Narrated Web Site===
  
*family_youngestmarried:
+
*name:
  
 +
navwebpage
  
*family_mostchildren:
+
*encoding:
  
 +
The encoding to be used for the web files
  
*person_oldestmother:
+
*pid:
  
 +
The center person for the filter
  
*person_oldestmarried:
+
*archive:
  
 +
Whether to store the web pages in an archive file
  
*person_oldestdivorced:
+
*living:
  
 +
How to handle living people
  
*person_oldestfather:
+
*graphgens:
  
 +
The number of generations to include in the ancestor graph
  
*person_oldestdied:
+
*title:
  
 +
The title of the web site
  
*person_youngestmother:
+
*incpriv:
  
 +
Whether to include private objects
  
*filter:
+
*graph:
  
Determines what people are included in the report
+
Whether to include an ancestor graph on each individual page
  
*person_youngestfather:
+
*footernote:
  
 +
A note to be used as the page footer
  
*pid:
+
*yearsafterdeath:
  
The center person for the filter
+
This allows you to restrict information on people who have not been dead for very long
  
*person_oldestliving:
+
*nogid:
  
 +
Whether to include the Gramps ID of objects
  
*person_youngestliving:
+
*contactnote:
  
 +
A note to be used as the publisher contact
  
*callname:
+
*showbirth:
  
 +
Whether to include a birth column
  
*family_shortest:
+
*cright:
  
 +
The copyright to be used for the web files
  
*person_youngestdivorced:
+
*css:
  
 +
The stylesheet to be used for the web page
  
*person_youngestmarried:
+
*incdownload:
  
 +
Whether to include a database download option
  
*family_oldestmarried:
+
*showparents:
  
 +
Whether to include a parents column
  
*person_youngestdied:
+
*showdeath:
  
===Common Options===
+
Whether to include a death column
  
*bookname: =name
+
*homenote:
  
Name of the book. MANDATORY
+
A note to be used on the home page
===Narrated Web Site===
 
  
*name:
+
*showspouse:
  
navwebpage
+
Whether to include a partners column
  
*encoding:
+
*headernote:
  
The encoding to be used for the web files
+
A note to be used as the page header
  
*pid:
+
*showhalfsiblings:
  
The center person for the filter
+
Whether to include half and/ or step-siblings with the parents and siblings
  
*archive:
+
*gallery:
  
Whether to store the web pages in an archive file
+
Whether to include a gallery of media objects
  
*living:
+
*homeimg:
  
How to handle living people
+
An image to be used on the home page
  
*graphgens:
+
*webcal_link:
  
The number of generations to include in the ancestor graph
+
Choose your link to Web Calendars if you want?
  
*title:
+
*linkhome:
  
The title of the web site
+
Whether to include a link to the home person
  
*incpriv:
+
*introimg:
  
Whether to include private objects
+
An image to be used as the introduction
  
*graph:
+
*filter:
  
Whether to include an ancestor graph on each individual page
+
Select filter to restrict people that appear on web site
  
*footernote:
+
*ext:
  
A note to be used as the page footer
+
The extension to be used for the web files
  
*yearsafterdeath:
+
*intronote:
  
This allows you to restrict information on people who have not been dead for very long
+
A note to be used as the introduction
  
*nogid:
+
*target:
  
Whether to include the Gramps ID of objects
+
The destination directory for the web files
  
*contactnote:
+
*contactimg:
  
A note to be used as the publisher contact
+
An image to be used as the publisher contact
 +
===Family Lines Graph===
  
*showbirth:
+
*name:
  
Whether to include a birth column
+
familylines_graph
  
*cright:
+
*color:
  
The copyright to be used for the web files
+
Males will be shown with blue, females with red, unless otherwise set above for filled. If the sex of an individual is unknown it will be shown with gray.
  
*css:
+
*surnamecolors:
  
The stylesheet to be used for the web page
+
Colours to use for various family lines.
  
*incdownload:
+
*incplaces:
  
Whether to include a database download option
+
Whether to include placenames for people and families.
  
*showparents:
+
*usesubgraphs:
  
Whether to include a parents column
+
Subgraphs can help GraphViz position certain linked nodes closer together, but with non-trivial graphs will result in longer lines and larger graphs.
  
*showdeath:
+
*justyears:
  
Whether to include a death column
+
Prints just dates' year, neither month or day nor date approximation or interval are shown.
  
*homenote:
+
*limitparents:
  
A note to be used on the home page
+
The maximum number of ancestors to include.
  
*showspouse:
+
*colorunknown:
  
Whether to include a partners column
+
The colour to use when the gender is unknown.
  
*headernote:
+
*colorfemales:
  
A note to be used as the page header
+
The colour to use to display women.
  
*showhalfsiblings:
+
*gidlist:
  
Whether to include half and/ or step-siblings with the parents and siblings
+
People of interest are used as a starting point when determining "family lines".
  
*gallery:
+
*followchild:
  
Whether to include a gallery of media objects
+
Children will be considered when determining "family lines".
  
*homeimg:
+
*incprivate:
  
An image to be used on the home page
+
Whether to include names, dates, and families that are marked as private.
  
*webcal_link:
+
*followpar:
  
Choose your link to Web Calendars if you want?
+
Parents and their ancestors will be considered when determining "family lines".
  
*linkhome:
+
*incdates:
  
Whether to include a link to the home person
+
Whether to include dates for people and families.
  
*introimg:
+
*colorfamilies:
  
An image to be used as the introduction
+
The colour to use to display families.
  
*filter:
+
*maxparents:
  
Select filter to restrict people that appear on web site
+
The maximum number of ancestors to include.
  
*ext:
+
*limitchildren:
  
The extension to be used for the web files
+
The maximum number of children to include.
  
*intronote:
+
*imageonside:
  
A note to be used as the introduction
+
Where the thumbnail image should appear relative to the name
  
*target:
+
*useroundedcorners:
  
The destination directory for the web files
+
Use rounded corners to differentiate between women and men.
  
*contactimg:
+
*removeextra:
  
An image to be used as the publisher contact
+
People and families not directly related to people of interest will be removed when determining "family lines".
===Family Lines Graph===
 
  
*name:
+
*maxchildren:
  
familylines_graph
+
The maximum number of children to include.
  
*color:
+
*incimages:
  
Males will be shown with blue, females with red, unless otherwise set above for filled. If the sex of an individual is unknown it will be shown with gray.
+
The maximum number of children to include.
  
*surnamecolors:
+
*incchildcnt:
  
Colours to use for various family lines.
+
Whether to include the number of children for families with more than 1 child.
  
*incplaces:
+
*colormales:
  
Whether to include placenames for people and families.
+
The colour to use to display men.
 +
===Relationship Graph===
  
*usesubgraphs:
+
*name:
  
Subgraphs can help GraphViz position certain linked nodes closer together, but with non-trivial graphs will result in longer lines and larger graphs.
+
rel_graph
  
*justyears:
+
*filter:
  
Prints just dates' year, neither month or day nor date approximation or interval are shown.
+
Determines what people are included in the graph
  
*limitparents:
+
*use_place:
  
The maximum number of ancestors to include.
+
When no birth, marriage, or death date is available, the correspondent place field will be used.
  
*colorunknown:
+
*incid:
  
The colour to use when the gender is unknown.
+
Include individual and family IDs.
  
*colorfemales:
+
*imageOnTheSide:
  
The colour to use to display women.
+
Where the thumbnail image should appear relative to the name
  
*gidlist:
+
*justyears:
  
People of interest are used as a starting point when determining "family lines".
+
Prints just dates' year, neither month or day nor date approximation or interval are shown.
  
*followchild:
+
*color:
  
Children will be considered when determining "family lines".
+
Males will be shown with blue, females with red. If the sex of an individual is unknown it will be shown with gray.
  
*incprivate:
+
*colorunknown:
  
Whether to include names, dates, and families that are marked as private.
+
The colour to use when the gender is unknown.
  
*followpar:
+
*incdate:
 +
 
 +
Include the dates that the individual was born, got married and/or died in the graph labels.
 +
 
 +
*pid:
  
Parents and their ancestors will be considered when determining "family lines".
+
The center person for the filter
  
*incdates:
+
*includeImages:
  
Whether to include dates for people and families.
+
Whether to include thumbnails of people.
  
 
*colorfamilies:
 
*colorfamilies:
Line 521: Line 538:
 
The colour to use to display families.
 
The colour to use to display families.
  
*maxparents:
+
*url:
  
The maximum number of ancestors to include.
+
Include a URL in each graph node so that PDF and imagemap files can be generated that contain active links to the files generated by the 'Narrated Web Site' report.
  
*limitchildren:
+
*arrow:
  
The maximum number of children to include.
+
Choose the direction that the arrows point.
  
*imageonside:
+
*dashed:
  
Where the thumbnail image should appear relative to the name
+
Non-birth relationships will show up as dotted lines in the graph.
  
*useroundedcorners:
+
*colorfemales:
  
Use rounded corners to differentiate between women and men.
+
The colour to use to display women.
  
*removeextra:
+
*colormales:
  
People and families not directly related to people of interest will be removed when determining "family lines".
+
The colour to use to display men.
  
*maxchildren:
+
*showfamily:
  
The maximum number of children to include.
+
Families will show up as ellipses, linked to parents and children.
  
*incimages:
+
*useroundedcorners:
  
The maximum number of children to include.
+
Use rounded corners to differentiate between women and men.
 +
===Hourglass Graph===
  
*incchildcnt:
+
*name:
  
Whether to include the number of children for families with more than 1 child.
+
hourglass_graph
  
*colormales:
+
*color:
  
The colour to use to display men.
+
Males will be shown with blue, females with red. If the sex of an individual is unknown it will be shown with gray.
===Relationship Graph===
 
  
*name:
+
*maxascend:
  
rel_graph
+
The number of generations of ancestors to include in the graph
  
*filter:
+
*roundcorners:
  
Determines what people are included in the graph
+
Use rounded corners to differentiate between women and men.
  
*use_place:
+
*pid:
  
When no birth, marriage, or death date is available, the correspondent place field will be used.
+
The Center person for the graph
  
*incid:
+
*maxdescend:
  
Include individual and family IDs.
+
The number of generations of descendants to include in the graph
 +
===Detailed Ancestral Report===
  
*imageOnTheSide:
+
*name:
  
Where the thumbnail image should appear relative to the name
+
det_ancestor_report
  
*justyears:
+
*repdate:
  
Prints just dates' year, neither month or day nor date approximation or interval are shown.
+
Whether to replace missing Dates with blanks.
  
*color:
+
*verbose:
  
Males will be shown with blue, females with red. If the sex of an individual is unknown it will be shown with gray.
+
Whether to use complete sentences or succinct language.
  
*colorunknown:
+
*usecall:
  
The colour to use when the gender is unknown.
+
Whether to use the call name as the first name.
 +
 
 +
*incsources:
 +
 
 +
Whether to include source references.
  
*incdate:
+
*incattrs:
  
Include the dates that the individual was born, got married and/or died in the graph labels.
+
Whether to include attributes.
  
 
*pid:
 
*pid:
  
The center person for the filter
+
The center person for the report
  
*includeImages:
+
*pagebbg:
  
Whether to include thumbnails of people.
+
Whether to start a new page after each generation.
  
*colorfamilies:
+
*incaddresses:
  
The colour to use to display families.
+
Whether to include addresses.
  
*url:
+
*incphotos:
  
Include a URL in each graph node so that PDF and imagemap files can be generated that contain active links to the files generated by the 'Narrated Web Site' report.
+
Whether to include images.
  
*arrow:
+
*desref:
  
Choose the direction that the arrows point.
+
Whether to add descendant references in child list.
  
*dashed:
+
*computeage:
  
Non-birth relationships will show up as dotted lines in the graph.
+
Whether to compute age.
  
*colorfemales:
+
*fulldates:
  
The colour to use to display women.
+
Whether to use full dates instead of just year.
  
*colormales:
+
*incnames:
  
The colour to use to display men.
+
Whether to include other names.
  
*showfamily:
+
*repplace:
  
Families will show up as ellipses, linked to parents and children.
+
Whether to replace missing Places with blanks.
  
*useroundedcorners:
+
*incevents:
  
Use rounded corners to differentiate between women and men.
+
Whether to include events.
===Hourglass Graph===
 
  
*name:
+
*incnotes:
  
hourglass_graph
+
Whether to include notes.
  
*color:
+
*omitda:
  
Males will be shown with blue, females with red. If the sex of an individual is unknown it will be shown with gray.
+
Whether to omit duplicate ancestors.
  
*maxascend:
+
*gen:
  
The number of generations of ancestors to include in the graph
+
The number of generations to include in the report
  
*roundcorners:
+
*listc:
  
Use rounded corners to differentiate between women and men.
+
Whether to list children.
 +
===Marker Report===
  
*pid:
+
*name:
  
The Center person for the graph
+
marker_report
  
*maxdescend:
+
*marker:
  
The number of generations of descendants to include in the graph
+
The marker to use for the report
===Detailed Ancestral Report===
+
===Family Group Report===
  
 
*name:
 
*name:
  
det_ancestor_report
+
family_group
  
*repdate:
+
*incParAddr:
  
Whether to replace missing Dates with blanks.
+
Whether to include addresses for parents.
  
*verbose:
+
*incParNames:
  
Whether to use complete sentences or succinct language.
+
Whether to include alternate names for parents.
  
*usecall:
+
*recursive:
  
Whether to use the call name as the first name.
+
Create reports for all descendants of this family.
  
*incsources:
+
*incChiMar:
  
Whether to include source references.
+
Whether to include marriage information for children.
  
*incattrs:
+
*incRelDates:
  
Whether to include attributes.
+
Whether to include dates for relatives (father, mother, spouse).
  
*pid:
+
*missinginfo:
  
The center person for the report
+
Whether to include fields for missing information.
  
*pagebbg:
+
*family_id:
  
Whether to start a new page after each generation.
+
The center family for the report
  
*incaddresses:
+
*incParEvents:
  
Whether to include addresses.
+
Whether to include events for parents.
  
*incphotos:
+
*incParMar:
  
Whether to include images.
+
Whether to include marriage information for parents.
  
*desref:
+
*incParNotes:
  
Whether to add descendant references in child list.
+
Whether to include notes for parents.
  
*computeage:
+
*incattrs:
  
Whether to compute age.
+
Whether to include attributes.
  
*fulldates:
+
*generations:
  
Whether to use full dates instead of just year.
+
Whether to include the generation on each report (recursive only).
 +
===Descendant Report===
  
*incnames:
+
*name:
  
Whether to include other names.
+
descend_report
  
*repplace:
+
*pid:
  
Whether to replace missing Places with blanks.
+
The center person for the report
  
*incevents:
+
*gen:
  
Whether to include events.
+
The number of generations to include in the report
 +
===Kinship Report===
  
*incnotes:
+
*name:
  
Whether to include notes.
+
kinship_report
  
*omitda:
+
*inccousins:
  
Whether to omit duplicate ancestors.
+
Whether to include cousins
  
*gen:
+
*pid:
  
The number of generations to include in the report
+
The center person for the report
  
*listc:
+
*maxdescend:
  
Whether to list children.
+
The maximum number of descendant generations
===Marker Report===
 
  
*name:
+
*maxascend:
  
marker_report
+
The maximum number of ancestor generations
  
*marker:
+
*incaunts:
  
The marker to use for the report
+
Whether to include aunts/uncles/nephews/nieces
===Family Group Report===
+
 
 +
*incspouses:
 +
 
 +
Whether to include spouses
 +
===Detailed Descendant Report===
  
 
*name:
 
*name:
  
family_group
+
det_descendant_report
  
*incParAddr:
+
*repdate:
  
Whether to include addresses for parents.
+
Whether to replace missing Dates with blanks.
  
*incParNames:
+
*pagebbg:
  
Whether to include alternate names for parents.
+
Whether to start a new page after each generation.
  
*recursive:
+
*verbose:
  
Create reports for all descendants of this family.
+
Whether to use complete sentences or succinct language.
  
*incChiMar:
+
*usecall:
  
Whether to include marriage information for children.
+
Whether to use the call name as the first name.
  
*incRelDates:
+
*incsources:
  
Whether to include dates for relatives (father, mother, spouse).
+
Whether to include source references.
  
*missinginfo:
+
*incattrs:
  
Whether to include fields for missing information.
+
Whether to include attributes.
  
*family_id:
+
*incmates:
  
The center family for the report
+
Whether to include detailed spouse information.
  
*incParEvents:
+
*pid:
  
Whether to include events for parents.
+
The center person for the report
  
*incParMar:
+
*incaddresses:
  
Whether to include marriage information for parents.
+
Whether to include addresses.
  
*incParNotes:
+
*incphotos:
  
Whether to include notes for parents.
+
Whether to include images.
  
*incattrs:
+
*desref:
  
Whether to include attributes.
+
Whether to add descendant references in child list.
  
*generations:
+
*computeage:
  
Whether to include the generation on each report (recursive only).
+
Whether to compute age.
===Descendant Report===
 
  
*name:
+
*fulldates:
  
descend_report
+
Whether to use full dates instead of just year.
  
*pid:
+
*incnames:
  
The center person for the report
+
Whether to include other names.
  
*gen:
+
*repplace:
  
The number of generations to include in the report
+
Whether to replace missing Places with blanks.
===Kinship Report===
 
  
*name:
+
*incevents:
  
kinship_report
+
Whether to include events.
  
*inccousins:
+
*record_num:
  
Whether to include cousins
+
Whether to use Record-style numbering instead of Henry-style.
  
*pid:
+
*incnotes:
  
The center person for the report
+
Whether to include notes.
  
*maxdescend:
+
*omitda:
  
The maximum number of descendant generations
+
Whether to omit duplicate ancestors.
  
*maxascend:
+
*gen:
  
The maximum number of ancestor generations
+
The number of generations to include in the report
  
*incaunts:
+
*listc:
  
Whether to include aunts/uncles/nephews/nieces
+
Whether to list children.
 +
===Database Summary Report===
  
*incspouses:
+
*name:
  
Whether to include spouses
+
summary
===Detailed Descendant Report===
+
===Number of Ancestors Report===
  
 
*name:
 
*name:
  
det_descendant_report
+
number_of_ancestors_report
  
*repdate:
+
*pid:
  
Whether to replace missing Dates with blanks.
+
The center person for the report
 +
===Ahnentafel Report===
 +
 
 +
*name:
 +
 
 +
ancestor_report
 +
 
 +
*maxgen:
 +
 
 +
The number of generations to include in the report
  
 
*pagebbg:
 
*pagebbg:
Line 857: Line 892:
 
Whether to start a new page after each generation.
 
Whether to start a new page after each generation.
  
*verbose:
+
*pid:
  
Whether to use complete sentences or succinct language.
+
The center person for the report
  
*usecall:
+
*namebrk:
  
Whether to use the call name as the first name.
+
Indicates if a line break should follow the name.
 +
===Birthday and Anniversary Report===
  
*incsources:
+
*name:
  
Whether to include source references.
+
birthday_report
  
*incattrs:
+
*relationships:
  
Whether to include attributes.
+
Include relationships to center person (slower)
  
*incmates:
+
*filter:
  
Whether to include detailed spouse information.
+
Select filter to restrict people that appear on calendar
  
*pid:
+
*anniversaries:
  
The center person for the report
+
Include anniversaries in the calendar
  
*incaddresses:
+
*start_dow:
  
Whether to include addresses.
+
Select the first day of the week for the calendar
  
*incphotos:
+
*name_format:
  
Whether to include images.
+
Select the format to display names
  
*desref:
+
*maiden_name:
  
Whether to add descendant references in child list.
+
Select married women's displayed surname
  
*computeage:
+
*country:
  
Whether to compute age.
+
Select the country to see associated holidays
  
*fulldates:
+
*birthdays:
  
Whether to use full dates instead of just year.
+
Include birthdays in the calendar
  
*incnames:
+
*pid:
  
Whether to include other names.
+
The center person for the report
  
*repplace:
+
*alive:
  
Whether to replace missing Places with blanks.
+
Include only living people in the calendar
  
*incevents:
+
*text2:
  
Whether to include events.
+
Second line of text at bottom of calendar
  
*record_num:
+
*text3:
  
Whether to use Record-style numbering instead of Henry-style.
+
Third line of text at bottom of calendar
  
*incnotes:
+
*text1:
  
Whether to include notes.
+
First line of text at bottom of calendar
  
*omitda:
+
*year:
  
Whether to omit duplicate ancestors.
+
Year of calendar
  
*gen:
+
*titletext:
  
The number of generations to include in the report
+
Title of calendar
 
+
===End of Line Report===
*listc:
 
 
 
Whether to list children.
 
===Database Summary Report===
 
  
 
*name:
 
*name:
  
summary
+
endofline_report
===Number of Ancestors Report===
 
 
 
*name:
 
 
 
number_of_ancestors_report
 
  
 
*pid:
 
*pid:
  
 
The center person for the report
 
The center person for the report
===Ahnentafel Report===
+
===Complete Individual Report===
  
 
*name:
 
*name:
  
ancestor_report
+
indiv_complete
  
*maxgen:
+
*filter:
  
The number of generations to include in the report
+
Select the filter to be applied to the report
  
*pagebbg:
+
*pid:
  
Whether to start a new page after each generation.
+
The center person for the filter
  
*pid:
+
*cites:
  
The center person for the report
+
Whether to cite sources.
 
+
===Place Report===
*namebrk:
 
 
 
Indicates if a line break should follow the name.
 
===Birthday and Anniversary Report===
 
  
 
*name:
 
*name:
  
birthday_report
+
place_report
  
*relationships:
+
*filter:
  
Include relationships to center person (slower)
+
Select places using a filter
  
*filter:
+
*places:
  
Select filter to restrict people that appear on calendar
+
List of places to report on
 +
===Descendant Tree===
  
*anniversaries:
+
*name:
  
Include anniversaries in the calendar
+
descend_chart
  
*start_dow:
+
*maxgen:
  
Select the first day of the week for the calendar
+
The number of generations to include in the tree
  
*name_format:
+
*singlep:
  
Select the format to display names
+
Whether to scale to fit on a single page.
  
*maiden_name:
+
*pid:
  
Select married women's displayed surname
+
The center person for the tree
  
*country:
+
*incblank:
  
Select the country to see associated holidays
+
Whether to include pages that are blank.
  
*birthdays:
+
*dispf:
  
Include birthdays in the calendar
+
Display format for the outputbox.
  
*pid:
+
*shows:
  
The center person for the report
+
Whether to show spouses in the tree.
 +
===Ancestor Tree===
  
*alive:
+
*name:
  
Include only living people in the calendar
+
ancestor_chart
  
*text2:
+
*maxgen:
 +
 
 +
The number of generations to include in the tree
 +
 
 +
*pid:
  
Second line of text at bottom of calendar
+
The center person for the tree
  
*text3:
+
*singlep:
  
Third line of text at bottom of calendar
+
Whether to scale to fit on a single page.
  
*text1:
+
*compress:
  
First line of text at bottom of calendar
+
Whether to compress the tree.
  
*year:
+
*incblank:
  
Year of calendar
+
Whether to include pages that are blank.
  
*titletext:
+
*dispf:
  
Title of calendar
+
Display format for the outputbox.
===End of Line Report===
+
===Fan Chart===
  
 
*name:
 
*name:
  
endofline_report
+
fan_chart
 +
 
 +
*maxgen:
 +
 
 +
The number of generations to include in the report
  
 
*pid:
 
*pid:
  
 
The center person for the report
 
The center person for the report
===Complete Individual Report===
 
  
*name:
+
*circle:
  
indiv_complete
+
The form of the graph: full circle, half circle, or quarter circle.
  
*filter:
+
*background:
  
Select the filter to be applied to the report
+
Background color is either white or generation dependent
  
*pid:
+
*radial:
  
The center person for the filter
+
Print radial texts upright or roundabout
 +
===Statistics Charts===
  
*cites:
+
*name:
  
Whether to cite sources.
+
statistics_chart
===Place Report===
 
  
*name:
+
*data_sname:
  
place_report
+
Include charts with indicated data
  
*filter:
+
*data_age:
  
Select places using a filter
+
Include charts with indicated data
  
*places:
+
*data_ccount:
  
List of places to report on
+
Include charts with indicated data
===Descendant Tree===
 
  
*name:
+
*bar_items:
  
descend_chart
+
With fewer items pie chart and legend will be used instead of a bar chart.
  
*maxgen:
+
*data_byear:
  
The number of generations to include in the tree
+
Include charts with indicated data
  
*singlep:
+
*data_etypes:
  
Whether to scale to fit on a single page.
+
Include charts with indicated data
  
*pid:
+
*data_dmonth:
  
The center person for the tree
+
Include charts with indicated data
  
*incblank:
+
*data_mage:
  
Whether to include pages that are blank.
+
Include charts with indicated data
  
*dispf:
+
*year_from:
  
Display format for the outputbox.
+
Birth year from which to include people
  
*shows:
+
*data_mcount:
  
Whether to show spouses in the tree.
+
Include charts with indicated data
===Ancestor Tree===
 
  
*name:
+
*data_title:
  
ancestor_chart
+
Include charts with indicated data
  
*maxgen:
+
*data_bmonth:
  
The number of generations to include in the tree
+
Include charts with indicated data
  
*pid:
+
*data_fname:
  
The center person for the tree
+
Include charts with indicated data
  
*singlep:
+
*data_dplace:
  
Whether to scale to fit on a single page.
+
Include charts with indicated data
  
*compress:
+
*data_fchild:
  
Whether to compress the tree.
+
Include charts with indicated data
  
*incblank:
+
*pid:
  
Whether to include pages that are blank.
+
The center person for the filter
  
*dispf:
+
*data_lchild:
  
Display format for the outputbox.
+
Include charts with indicated data
===Fan Chart===
 
  
*name:
+
*data_dage:
  
fan_chart
+
Include charts with indicated data
  
*maxgen:
+
*data_mplace:
  
The number of generations to include in the report
+
Include charts with indicated data
  
*pid:
+
*data_dyear:
  
The center person for the report
+
Include charts with indicated data
  
*circle:
+
*data_bplace:
  
The form of the graph: full circle, half circle, or quarter circle.
+
Include charts with indicated data
  
*background:
+
*reverse:
  
Background color is either white or generation dependent
+
Check to reverse the sorting order.
  
*radial:
+
*gender:
  
Print radial texts upright or roundabout
+
Select which genders are included into statistics.
===Statistics Charts===
 
  
*name:
+
*filter:
  
statistics_chart
+
Determines what people are included in the report
  
*data_sname:
+
*no_years:
  
Include charts with indicated data
+
Whether to include people without known birth years
  
*data_age:
+
*sortby:
  
Include charts with indicated data
+
Select how the statistical data is sorted.
  
*data_ccount:
+
*year_to:
  
Include charts with indicated data
+
Birth year until which to include people
  
*bar_items:
+
*data_gender:
  
With fewer items pie chart and legend will be used instead of a bar chart.
+
Include charts with indicated data
 +
===Calendar===
  
*data_byear:
+
*name:
  
Include charts with indicated data
+
calendar
  
*data_etypes:
+
*filter:
  
Include charts with indicated data
+
Select filter to restrict people that appear on calendar
  
*data_dmonth:
+
*anniversaries:
  
Include charts with indicated data
+
Include anniversaries in the calendar
  
*data_mage:
+
*start_dow:
  
Include charts with indicated data
+
Select the first day of the week for the calendar
  
*year_from:
+
*name_format:
  
Birth year from which to include people
+
Select the format to display names
  
*data_mcount:
+
*maiden_name:
  
Include charts with indicated data
+
Select married women's displayed surname
  
*data_title:
+
*country:
  
Include charts with indicated data
+
Select the country to see associated holidays
  
*data_bmonth:
+
*birthdays:
  
Include charts with indicated data
+
Include birthdays in the calendar
  
*data_fname:
+
*pid:
  
Include charts with indicated data
+
The center person for the report
  
*data_dplace:
+
*alive:
  
Include charts with indicated data
+
Include only living people in the calendar
  
*data_fchild:
+
*text2:
  
Include charts with indicated data
+
Second line of text at bottom of calendar
  
*pid:
+
*text3:
  
The center person for the filter
+
Third line of text at bottom of calendar
  
*data_lchild:
+
*text1:
  
Include charts with indicated data
+
First line of text at bottom of calendar
  
*data_dage:
+
*year:
  
Include charts with indicated data
+
Year of calendar
 +
===Timeline Chart===
  
*data_mplace:
+
*name:
  
Include charts with indicated data
+
timeline
  
*data_dyear:
+
*filter:
  
Include charts with indicated data
+
Determines what people are included in the report
  
*data_bplace:
+
*calendar:
  
Include charts with indicated data
+
The calendar which determines the year span
  
*reverse:
+
*pid:
  
Check to reverse the sorting order.
+
The center person for the filter
  
*gender:
+
*sortby:
  
Select which genders are included into statistics.
+
Sorting method to use
  
*filter:
+
==Tools==
  
Determines what people are included in the report
+
===Common Options===
  
*no_years:
+
*id: =ID
  
Whether to include people without known birth years
+
Gramps ID of a central person.
  
*sortby:
+
I4 Smith, Ingeman
  
Select how the statistical data is sorted.
+
I18 Smith, John Hjalmar
  
*year_to:
+
I38 Hansdotter, Kerstina
  
Birth year until which to include people
+
I39 Smith, Martin
  
*data_gender:
+
I28 Streiffert, Anna
  
Include charts with indicated data
+
I40 Smith, Marjorie Alice
===Calendar===
 
  
*name:
+
I22 Smith, Martin
  
calendar
+
I11 Smith, Hanna
  
*filter:
+
I41 Green, Janis Elaine
  
Select filter to restrict people that appear on calendar
+
I15 Smith, Gus
  
*anniversaries:
+
I8 Smith, Hjalmar
  
Include anniversaries in the calendar
+
I3 Smith, Magnes
  
*start_dow:
+
I5 Smith, Mason Michael
  
Select the first day of the week for the calendar
+
I10 Smith, Hans Peter
  
*name_format:
+
I24 Smith, Gustaf Sr.
  
Select the format to display names
+
I20 Smith, Carl Emil
  
*maiden_name:
+
I17 Jones, Lillie Harriet
  
Select married women's displayed surname
+
I23 Smith, Astrid Shermanna Augusta
  
*country:
+
I1 Smith, Keith Lloyd
  
Select the country to see associated holidays
+
I37 Smith, Edwin Michael
  
*birthdays:
+
I19 Smith, Eric Lloyd
  
Include birthdays in the calendar
+
I25 Ericsdotter, Marta
  
*pid:
+
I29 Smith, Craig Peter
  
The center person for the report
+
I2 Smith, Amber Marie
  
*alive:
+
I33 Smith, Lloyd
  
Include only living people in the calendar
+
I32 Horne, Darcy
  
*text2:
+
I26 Smith, Kirsti Marie
  
Second line of text at bottom of calendar
+
I35 Smith, Lars Peter
  
*text3:
+
I30 Adams, Janice Ann
  
Third line of text at bottom of calendar
+
I0 Hansdotter, Anna
  
*text1:
+
I31 Ohman, Marjorie
  
First line of text at bottom of calendar
+
I12 Nielsen, Herman Julius
  
*year:
+
I9 Smith, Emil
  
Year of calendar
+
I27 Smith, Ingeman
===Timeline Chart===
 
  
*name:
+
I36 Jefferson, Elna
  
timeline
+
I21 Smith, Hjalmar
  
*filter:
+
I34 Perkins, Alice Paula
  
Determines what people are included in the report
+
I14 Smith, Marjorie Lee
  
*calendar:
+
I7 Smith, Ingar
  
The calendar which determines the year span
+
I6 Willard, Edwin
  
*pid:
+
I16 Anderson, Jennifer
  
The center person for the filter
+
I13 Michaels, Evelyn
 +
===Check and Repair Database===
  
*sortby:
+
*name:
  
Sorting method to use
+
check
 +
===Rebuild Reference Maps===
  
==Tools==
+
*name:
  
===Common Options===
+
rebuild_refmap
 +
===Check Localized Date Displayer and Parser===
  
*id: =ID
+
*name:
  
Gramps ID of a central person.
+
test_for_date_parser_and_displayer
 +
===Rename Event Types===
  
I4 Smith, Ingeman
+
*name:
  
I18 Smith, John Hjalmar
+
chtype
  
I38 Hansdotter, Kerstina
+
*fromtype: =str
  
I39 Smith, Martin
+
Type of events to replace
  
I28 Streiffert, Anna
+
Value: ''Event type string''
  
I40 Smith, Marjorie Alice
+
*totype: =str
  
I22 Smith, Martin
+
New type replacing the old one
  
I11 Smith, Hanna
+
Value: ''Event type string''
 +
===Dump Gender Statistics===
  
I41 Green, Janis Elaine
+
*name:
  
I15 Smith, Gus
+
dgenstats
 +
===Generate Testcases for Persons and Families===
 +
Generates a ([https://www.statisticshowto.com/random-seed-definition/ seeded]) randomized tree to allow specific error conditions to be tested. The issues it generates can be corrected via the '[[Check_and_Repair_Tool|Check and Repair]]' tool.
  
I8 Smith, Hjalmar
+
====Usage====
 +
*name:
  
I3 Smith, Magnes
+
<code>testcasegenerator</code>
 +
====Parameters====
 +
*add_linebreak: =0/1 <br />Whether to add a line break to every text field
 +
** No linebreak
 +
** Add line break
  
I5 Smith, Mason Michael
+
*person_count: =int <br />Number of dummy persons to generate
 +
** Value: ''Number of persons''
  
I10 Smith, Hans Peter
+
*no_trans: =0/1 <br />Whether to use one transaction or multiple small ones
 +
** One transaction
 +
** Multiple transactions
  
I24 Smith, Gustaf Sr.
+
*long_names: =0/1 <br />Whether to create short or long names
 +
** Short names
 +
** Long names
  
I20 Smith, Carl Emil
+
*bugs: =0/1 <br />Whether to create invalid database references.
 +
** Skip test
 +
** Create invalid Database references
  
I17 Jones, Lillie Harriet
+
*persons: =0/1 <br />Whether to create a bunch of dummy persons
 +
** Don't create persons
 +
** Create dummy persons
  
I23 Smith, Astrid Shermanna Augusta
+
*add_serial: =0/1 <br />Whether to add a serial number to every text field
 +
** No serial
 +
** Add serial number
  
I1 Smith, Keith Lloyd
+
*specialchars: =0/1 <br />Whether to add some special characters to every text field
 +
** No special characters
 +
** Add special characters
  
I37 Smith, Edwin Michael
+
===Verify the Data===
  
I19 Smith, Eric Lloyd
+
*name:
  
I25 Ericsdotter, Marta
+
verify
  
I29 Smith, Craig Peter
+
*lngwdw: =num
  
I2 Smith, Amber Marie
+
Maximum number of consecutive years of widowhood before next marriage
  
I33 Smith, Lloyd
+
Value: ''Number of years''
  
I32 Horne, Darcy
+
*mxchildmom: =num
  
I26 Smith, Kirsti Marie
+
Maximum number of children for a woman
  
I35 Smith, Lars Peter
+
Value: ''Number of children''
  
I30 Adams, Janice Ann
+
*wedder: =num
  
I0 Hansdotter, Anna
+
Maximum number of spouses for a person
  
I31 Ohman, Marjorie
+
Value: ''Number of spouses''
  
I12 Nielsen, Herman Julius
+
*oldunm: =num
  
I9 Smith, Emil
+
Maximum age for an unmarried personNumber of years
  
I27 Smith, Ingeman
+
*mxchilddad: =num
  
I36 Jefferson, Elna
+
Maximum number of children for a man
  
I21 Smith, Hjalmar
+
Value: ''Number of chidlren''
  
I34 Perkins, Alice Paula
+
*estimate_age: =0/1
  
I14 Smith, Marjorie Lee
+
Whether to estimate missing dates
  
I7 Smith, Ingar
+
Do not estimate
  
I6 Willard, Edwin
+
Estimate dates
  
I16 Anderson, Jennifer
+
*yngmar: =num
  
I13 Michaels, Evelyn
+
Minimum age to marry
===Check and Repair Database===
 
  
*name:
+
Value: ''Age in years''
  
check
+
*oldmar: =num
===Rebuild Reference Maps===
 
  
*name:
+
Maximum age to marry
  
rebuild_refmap
+
Value: ''Age in years''
===Check Localized Date Displayer and Parser===
 
  
*name:
+
*cbspan: =num
  
test_for_date_parser_and_displayer
+
Maximum span of years for all children
===Rename Event Types===
 
  
*name:
+
Value: ''Span in years''
  
chtype
+
*oldage: =num
  
*fromtype: =str
+
Maximum age
  
Type of events to replace
+
Value: ''Age in years''
  
Value: ''Event type string''
+
*olddad: =num
  
*totype: =str
+
Maximum age to father a child
  
New type replacing the old one
+
Value: ''Age in years''
  
Value: ''Event type string''
+
*hwdif: =num
===Dump Gender Statistics===
 
  
*name:
+
Maximum husband-wife age difference
  
dgenstats
+
Value: ''Age difference in years''
===Generate Testcases for Persons and Families===
 
  
*name:
+
*invdate: =0/1
  
testcasegenerator
+
Whether to check for invalid datesDo not identify invalid dates
  
*add_linebreak: =0/1
+
Value: ''Identify invalid dates''
  
Wheter to add a line break to every text field
+
*yngmom: =num
  
No linebreak
+
Minimum age to bear a child
  
Add line break
+
Value: ''Age in years''
  
*person_count: =int
+
*yngdad: =num
  
Number of dummy persons to generate
+
Minimum age to father a child
  
Value: ''Number of persons''
+
Value: ''Age in years''
  
*no_trans: =0/1
+
*oldmom: =num
  
Wheter to use one transaction or multiple small ones
+
Maximum age to bear a child
  
One transaction
+
Value: ''Age in years''
  
Multiple transactions
+
*cspace: =num
  
*long_names: =0/1
+
Maximum number of years between children
  
Wheter to create short or long names
+
Value: ''Number of years''
 +
===Rebuild Secondary Indices===
  
Short names
+
*name:
  
Long names
+
rebuild
 +
===Generate Commandline Plugin Reference===
  
*bugs: =0/1
+
*name:
  
Whether to create invalid database references.
+
cmdref
  
Skip test
+
*include: =0/1
  
Create invalid Database references
+
Whether to include into the manual
  
*persons: =0/1
+
Do not include
  
Whether to create a bunch of dummy persons
+
Include
  
Dont create persons
+
*target: =str
  
Create dummy persons
+
Pathname to the target file
  
*add_serial: =0/1
+
Value: ''Any valid pathname''
  
Wheter to add a serial number to every text field
+
===Reorder Gramps IDs===
 
 
No serial
 
 
 
Add serial number
 
 
 
*specialchars: =0/1
 
 
 
Wheter to ass some special characters to every text field
 
 
 
No special characters
 
 
 
Add special characters
 
===Verify the Data===
 
  
 
*name:
 
*name:
  
verify
+
reorder_ids
 
 
*lngwdw: =num
 
  
Maximum number of consecutive years of widowhood before next marriage
+
[[Category:Documentation]]
 
+
[[Category:Plugins|C]]
Value: ''Number of years''
+
[[Category:Reports|C]]
 
 
*mxchildmom: =num
 
 
 
Maximum number of children for a woman
 
 
 
Value: ''Number of children''
 
 
 
*wedder: =num
 
 
 
Maximum number of spouses for a person
 
 
 
Value: ''Number of spouses''
 
 
 
*oldunm: =num
 
 
 
Maximum age for an unmarried personNumber of years
 
 
 
*mxchilddad: =num
 
 
 
Maximum number of children for a man
 
 
 
Value: ''Number of chidlren''
 
 
 
*estimate_age: =0/1
 
 
 
Whether to estimate missing dates
 
 
 
Do not estimate
 
 
 
Estimate dates
 
 
 
*yngmar: =num
 
 
 
Minimum age to marry
 
 
 
Value: ''Age in years''
 
 
 
*oldmar: =num
 
 
 
Maximum age to marry
 
 
 
Value: ''Age in years''
 
 
 
*cbspan: =num
 
 
 
Maximum span of years for all children
 
 
 
Value: ''Span in years''
 
 
 
*oldage: =num
 
 
 
Maximum age
 
 
 
Value: ''Age in years''
 
 
 
*olddad: =num
 
 
 
Maximum age to father a child
 
 
 
Value: ''Age in years''
 
 
 
*hwdif: =num
 
 
 
Maximum husband-wife age difference
 
 
 
Value: ''Age difference in years''
 
 
 
*invdate: =0/1
 
 
 
Whether to check for invalid datesDo not identify invalid dates
 
 
 
Value: ''Identify invalid dates''
 
 
 
*yngmom: =num
 
 
 
Minimum age to bear a child
 
 
 
Value: ''Age in years''
 
 
 
*yngdad: =num
 
 
 
Minimum age to father a child
 
 
 
Value: ''Age in years''
 
 
 
*oldmom: =num
 
 
 
Maximum age to bear a child
 
 
 
Value: ''Age in years''
 
 
 
*cspace: =num
 
 
 
Maximum number of years between children
 
 
 
Value: ''Number of years''
 
===Rebuild Secondary Indices===
 
 
 
*name:
 
 
 
rebuild
 
===Generate Commandline Plugin Reference===
 
 
 
*name:
 
 
 
cmdref
 
 
 
*include: =0/1
 
 
 
Whether to include into the manual
 
 
 
Do not include
 
 
 
Include
 
 
 
*target: =str
 
 
 
Pathname to the target file
 
 
 
Value: ''Any valid pathname''
 
 
 
===Reorder GRAMPS IDs===
 
 
 
*name:
 
 
 
reorder_ids
 

Latest revision as of 16:46, 2 September 2021

Gramps-notes.png

Please update or expand this section.


Available options to use from the command line for reports and tools.

In general the process of learning about a command line option is easy.

First, learn the name of all the reports or tools:

gramps -O "My Family Tree" -a report
gramps -O "My Family Tree" -a tool

Second, learn all the options of the particular report or tool.

gramps -O "My Family Tree" -a report -p name=a_report,show=all
gramps -O "My Family Tree" -a tool -p name=a_tool,show=all

Third, learn what a particular option is.

gramps -O "My Family Tree" -a report -p name=a_report,show=some_option
gramps -O "My Family Tree" -a tool -p name=a_tool,show=some_option

See Command Line for more information.

Reports

Common Options

  • pid:

The center person for the filter

I18 Smith, John Hjalmar

  • callname:

0 Don't use call name

1 Replace first name with call name

2 Underline call name in first name / add call name to first name

  • person_youngestmarried:

0 no

1 yes

  • person_youngestdivorced:

0 no

1 yes

  • style: =name

Style name.

Value: '

  • family_youngestmarried:

0 no

1 yes

  • person_oldestmother:

0 no

1 yes

  • papero: =num

Paper orientation number.

Value: '

  • person_oldestdivorced:

0 no

1 yes

  • person_youngestfather:

0 no

1 yes

  • template: =name

Template name (HTML only).

Value: '

  • papers: =name

Paper size name.

Value: '

  • person_youngestliving:

0 no

1 yes

  • family_longest:

0 no

1 yes

  • person_oldestliving:

0 no

1 yes

  • person_oldestfather:

0 no

1 yes

  • family_mostchildren:

0 no

1 yes

  • family_oldestmarried:

0 no

1 yes

  • person_oldestmarried:

0 no

1 yes

  • off: =format

Output file format.

Value: '

  • of: =filename

Output file name. MANDATORY

Value: '

  • person_oldestdied:

0 no

1 yes

  • person_youngestmother:

0 no

1 yes

  • filter:

Determines what people are included in the report

0 Entire Database

1 Descendants of Smith, Edwin Michael

2 Descendant Families of Smith, Edwin Michael

3 Ancestors of Smith, Edwin Michael

4 People with common ancestor with Smith, Edwin Michael

  • family_shortest:

0 no

1 yes

  • person_youngestdied:

0 no

1 yes

Records Report

  • name:

records

  • family_longest:


  • family_youngestmarried:


  • family_mostchildren:


  • person_oldestmother:


  • person_oldestmarried:


  • person_oldestdivorced:


  • person_oldestfather:


  • person_oldestdied:


  • person_youngestmother:


  • filter:

Determines what people are included in the report

  • person_youngestfather:


  • pid:

The center person for the filter

  • person_oldestliving:


  • person_youngestliving:


  • callname:


  • family_shortest:


  • person_youngestdivorced:


  • person_youngestmarried:


  • family_oldestmarried:


  • person_youngestdied:

Common Options

  • bookname: =name

Name of the book. MANDATORY

Narrated Web Site

  • name:

navwebpage

  • encoding:

The encoding to be used for the web files

  • pid:

The center person for the filter

  • archive:

Whether to store the web pages in an archive file

  • living:

How to handle living people

  • graphgens:

The number of generations to include in the ancestor graph

  • title:

The title of the web site

  • incpriv:

Whether to include private objects

  • graph:

Whether to include an ancestor graph on each individual page

  • footernote:

A note to be used as the page footer

  • yearsafterdeath:

This allows you to restrict information on people who have not been dead for very long

  • nogid:

Whether to include the Gramps ID of objects

  • contactnote:

A note to be used as the publisher contact

  • showbirth:

Whether to include a birth column

  • cright:

The copyright to be used for the web files

  • css:

The stylesheet to be used for the web page

  • incdownload:

Whether to include a database download option

  • showparents:

Whether to include a parents column

  • showdeath:

Whether to include a death column

  • homenote:

A note to be used on the home page

  • showspouse:

Whether to include a partners column

  • headernote:

A note to be used as the page header

  • showhalfsiblings:

Whether to include half and/ or step-siblings with the parents and siblings

  • gallery:

Whether to include a gallery of media objects

  • homeimg:

An image to be used on the home page

  • webcal_link:

Choose your link to Web Calendars if you want?

  • linkhome:

Whether to include a link to the home person

  • introimg:

An image to be used as the introduction

  • filter:

Select filter to restrict people that appear on web site

  • ext:

The extension to be used for the web files

  • intronote:

A note to be used as the introduction

  • target:

The destination directory for the web files

  • contactimg:

An image to be used as the publisher contact

Family Lines Graph

  • name:

familylines_graph

  • color:

Males will be shown with blue, females with red, unless otherwise set above for filled. If the sex of an individual is unknown it will be shown with gray.

  • surnamecolors:

Colours to use for various family lines.

  • incplaces:

Whether to include placenames for people and families.

  • usesubgraphs:

Subgraphs can help GraphViz position certain linked nodes closer together, but with non-trivial graphs will result in longer lines and larger graphs.

  • justyears:

Prints just dates' year, neither month or day nor date approximation or interval are shown.

  • limitparents:

The maximum number of ancestors to include.

  • colorunknown:

The colour to use when the gender is unknown.

  • colorfemales:

The colour to use to display women.

  • gidlist:

People of interest are used as a starting point when determining "family lines".

  • followchild:

Children will be considered when determining "family lines".

  • incprivate:

Whether to include names, dates, and families that are marked as private.

  • followpar:

Parents and their ancestors will be considered when determining "family lines".

  • incdates:

Whether to include dates for people and families.

  • colorfamilies:

The colour to use to display families.

  • maxparents:

The maximum number of ancestors to include.

  • limitchildren:

The maximum number of children to include.

  • imageonside:

Where the thumbnail image should appear relative to the name

  • useroundedcorners:

Use rounded corners to differentiate between women and men.

  • removeextra:

People and families not directly related to people of interest will be removed when determining "family lines".

  • maxchildren:

The maximum number of children to include.

  • incimages:

The maximum number of children to include.

  • incchildcnt:

Whether to include the number of children for families with more than 1 child.

  • colormales:

The colour to use to display men.

Relationship Graph

  • name:

rel_graph

  • filter:

Determines what people are included in the graph

  • use_place:

When no birth, marriage, or death date is available, the correspondent place field will be used.

  • incid:

Include individual and family IDs.

  • imageOnTheSide:

Where the thumbnail image should appear relative to the name

  • justyears:

Prints just dates' year, neither month or day nor date approximation or interval are shown.

  • color:

Males will be shown with blue, females with red. If the sex of an individual is unknown it will be shown with gray.

  • colorunknown:

The colour to use when the gender is unknown.

  • incdate:

Include the dates that the individual was born, got married and/or died in the graph labels.

  • pid:

The center person for the filter

  • includeImages:

Whether to include thumbnails of people.

  • colorfamilies:

The colour to use to display families.

  • url:

Include a URL in each graph node so that PDF and imagemap files can be generated that contain active links to the files generated by the 'Narrated Web Site' report.

  • arrow:

Choose the direction that the arrows point.

  • dashed:

Non-birth relationships will show up as dotted lines in the graph.

  • colorfemales:

The colour to use to display women.

  • colormales:

The colour to use to display men.

  • showfamily:

Families will show up as ellipses, linked to parents and children.

  • useroundedcorners:

Use rounded corners to differentiate between women and men.

Hourglass Graph

  • name:

hourglass_graph

  • color:

Males will be shown with blue, females with red. If the sex of an individual is unknown it will be shown with gray.

  • maxascend:

The number of generations of ancestors to include in the graph

  • roundcorners:

Use rounded corners to differentiate between women and men.

  • pid:

The Center person for the graph

  • maxdescend:

The number of generations of descendants to include in the graph

Detailed Ancestral Report

  • name:

det_ancestor_report

  • repdate:

Whether to replace missing Dates with blanks.

  • verbose:

Whether to use complete sentences or succinct language.

  • usecall:

Whether to use the call name as the first name.

  • incsources:

Whether to include source references.

  • incattrs:

Whether to include attributes.

  • pid:

The center person for the report

  • pagebbg:

Whether to start a new page after each generation.

  • incaddresses:

Whether to include addresses.

  • incphotos:

Whether to include images.

  • desref:

Whether to add descendant references in child list.

  • computeage:

Whether to compute age.

  • fulldates:

Whether to use full dates instead of just year.

  • incnames:

Whether to include other names.

  • repplace:

Whether to replace missing Places with blanks.

  • incevents:

Whether to include events.

  • incnotes:

Whether to include notes.

  • omitda:

Whether to omit duplicate ancestors.

  • gen:

The number of generations to include in the report

  • listc:

Whether to list children.

Marker Report

  • name:

marker_report

  • marker:

The marker to use for the report

Family Group Report

  • name:

family_group

  • incParAddr:

Whether to include addresses for parents.

  • incParNames:

Whether to include alternate names for parents.

  • recursive:

Create reports for all descendants of this family.

  • incChiMar:

Whether to include marriage information for children.

  • incRelDates:

Whether to include dates for relatives (father, mother, spouse).

  • missinginfo:

Whether to include fields for missing information.

  • family_id:

The center family for the report

  • incParEvents:

Whether to include events for parents.

  • incParMar:

Whether to include marriage information for parents.

  • incParNotes:

Whether to include notes for parents.

  • incattrs:

Whether to include attributes.

  • generations:

Whether to include the generation on each report (recursive only).

Descendant Report

  • name:

descend_report

  • pid:

The center person for the report

  • gen:

The number of generations to include in the report

Kinship Report

  • name:

kinship_report

  • inccousins:

Whether to include cousins

  • pid:

The center person for the report

  • maxdescend:

The maximum number of descendant generations

  • maxascend:

The maximum number of ancestor generations

  • incaunts:

Whether to include aunts/uncles/nephews/nieces

  • incspouses:

Whether to include spouses

Detailed Descendant Report

  • name:

det_descendant_report

  • repdate:

Whether to replace missing Dates with blanks.

  • pagebbg:

Whether to start a new page after each generation.

  • verbose:

Whether to use complete sentences or succinct language.

  • usecall:

Whether to use the call name as the first name.

  • incsources:

Whether to include source references.

  • incattrs:

Whether to include attributes.

  • incmates:

Whether to include detailed spouse information.

  • pid:

The center person for the report

  • incaddresses:

Whether to include addresses.

  • incphotos:

Whether to include images.

  • desref:

Whether to add descendant references in child list.

  • computeage:

Whether to compute age.

  • fulldates:

Whether to use full dates instead of just year.

  • incnames:

Whether to include other names.

  • repplace:

Whether to replace missing Places with blanks.

  • incevents:

Whether to include events.

  • record_num:

Whether to use Record-style numbering instead of Henry-style.

  • incnotes:

Whether to include notes.

  • omitda:

Whether to omit duplicate ancestors.

  • gen:

The number of generations to include in the report

  • listc:

Whether to list children.

Database Summary Report

  • name:

summary

Number of Ancestors Report

  • name:

number_of_ancestors_report

  • pid:

The center person for the report

Ahnentafel Report

  • name:

ancestor_report

  • maxgen:

The number of generations to include in the report

  • pagebbg:

Whether to start a new page after each generation.

  • pid:

The center person for the report

  • namebrk:

Indicates if a line break should follow the name.

Birthday and Anniversary Report

  • name:

birthday_report

  • relationships:

Include relationships to center person (slower)

  • filter:

Select filter to restrict people that appear on calendar

  • anniversaries:

Include anniversaries in the calendar

  • start_dow:

Select the first day of the week for the calendar

  • name_format:

Select the format to display names

  • maiden_name:

Select married women's displayed surname

  • country:

Select the country to see associated holidays

  • birthdays:

Include birthdays in the calendar

  • pid:

The center person for the report

  • alive:

Include only living people in the calendar

  • text2:

Second line of text at bottom of calendar

  • text3:

Third line of text at bottom of calendar

  • text1:

First line of text at bottom of calendar

  • year:

Year of calendar

  • titletext:

Title of calendar

End of Line Report

  • name:

endofline_report

  • pid:

The center person for the report

Complete Individual Report

  • name:

indiv_complete

  • filter:

Select the filter to be applied to the report

  • pid:

The center person for the filter

  • cites:

Whether to cite sources.

Place Report

  • name:

place_report

  • filter:

Select places using a filter

  • places:

List of places to report on

Descendant Tree

  • name:

descend_chart

  • maxgen:

The number of generations to include in the tree

  • singlep:

Whether to scale to fit on a single page.

  • pid:

The center person for the tree

  • incblank:

Whether to include pages that are blank.

  • dispf:

Display format for the outputbox.

  • shows:

Whether to show spouses in the tree.

Ancestor Tree

  • name:

ancestor_chart

  • maxgen:

The number of generations to include in the tree

  • pid:

The center person for the tree

  • singlep:

Whether to scale to fit on a single page.

  • compress:

Whether to compress the tree.

  • incblank:

Whether to include pages that are blank.

  • dispf:

Display format for the outputbox.

Fan Chart

  • name:

fan_chart

  • maxgen:

The number of generations to include in the report

  • pid:

The center person for the report

  • circle:

The form of the graph: full circle, half circle, or quarter circle.

  • background:

Background color is either white or generation dependent

  • radial:

Print radial texts upright or roundabout

Statistics Charts

  • name:

statistics_chart

  • data_sname:

Include charts with indicated data

  • data_age:

Include charts with indicated data

  • data_ccount:

Include charts with indicated data

  • bar_items:

With fewer items pie chart and legend will be used instead of a bar chart.

  • data_byear:

Include charts with indicated data

  • data_etypes:

Include charts with indicated data

  • data_dmonth:

Include charts with indicated data

  • data_mage:

Include charts with indicated data

  • year_from:

Birth year from which to include people

  • data_mcount:

Include charts with indicated data

  • data_title:

Include charts with indicated data

  • data_bmonth:

Include charts with indicated data

  • data_fname:

Include charts with indicated data

  • data_dplace:

Include charts with indicated data

  • data_fchild:

Include charts with indicated data

  • pid:

The center person for the filter

  • data_lchild:

Include charts with indicated data

  • data_dage:

Include charts with indicated data

  • data_mplace:

Include charts with indicated data

  • data_dyear:

Include charts with indicated data

  • data_bplace:

Include charts with indicated data

  • reverse:

Check to reverse the sorting order.

  • gender:

Select which genders are included into statistics.

  • filter:

Determines what people are included in the report

  • no_years:

Whether to include people without known birth years

  • sortby:

Select how the statistical data is sorted.

  • year_to:

Birth year until which to include people

  • data_gender:

Include charts with indicated data

Calendar

  • name:

calendar

  • filter:

Select filter to restrict people that appear on calendar

  • anniversaries:

Include anniversaries in the calendar

  • start_dow:

Select the first day of the week for the calendar

  • name_format:

Select the format to display names

  • maiden_name:

Select married women's displayed surname

  • country:

Select the country to see associated holidays

  • birthdays:

Include birthdays in the calendar

  • pid:

The center person for the report

  • alive:

Include only living people in the calendar

  • text2:

Second line of text at bottom of calendar

  • text3:

Third line of text at bottom of calendar

  • text1:

First line of text at bottom of calendar

  • year:

Year of calendar

Timeline Chart

  • name:

timeline

  • filter:

Determines what people are included in the report

  • calendar:

The calendar which determines the year span

  • pid:

The center person for the filter

  • sortby:

Sorting method to use

Tools

Common Options

  • id: =ID

Gramps ID of a central person.

I4 Smith, Ingeman

I18 Smith, John Hjalmar

I38 Hansdotter, Kerstina

I39 Smith, Martin

I28 Streiffert, Anna

I40 Smith, Marjorie Alice

I22 Smith, Martin

I11 Smith, Hanna

I41 Green, Janis Elaine

I15 Smith, Gus

I8 Smith, Hjalmar

I3 Smith, Magnes

I5 Smith, Mason Michael

I10 Smith, Hans Peter

I24 Smith, Gustaf Sr.

I20 Smith, Carl Emil

I17 Jones, Lillie Harriet

I23 Smith, Astrid Shermanna Augusta

I1 Smith, Keith Lloyd

I37 Smith, Edwin Michael

I19 Smith, Eric Lloyd

I25 Ericsdotter, Marta

I29 Smith, Craig Peter

I2 Smith, Amber Marie

I33 Smith, Lloyd

I32 Horne, Darcy

I26 Smith, Kirsti Marie

I35 Smith, Lars Peter

I30 Adams, Janice Ann

I0 Hansdotter, Anna

I31 Ohman, Marjorie

I12 Nielsen, Herman Julius

I9 Smith, Emil

I27 Smith, Ingeman

I36 Jefferson, Elna

I21 Smith, Hjalmar

I34 Perkins, Alice Paula

I14 Smith, Marjorie Lee

I7 Smith, Ingar

I6 Willard, Edwin

I16 Anderson, Jennifer

I13 Michaels, Evelyn

Check and Repair Database

  • name:

check

Rebuild Reference Maps

  • name:

rebuild_refmap

Check Localized Date Displayer and Parser

  • name:

test_for_date_parser_and_displayer

Rename Event Types

  • name:

chtype

  • fromtype: =str

Type of events to replace

Value: Event type string

  • totype: =str

New type replacing the old one

Value: Event type string

Dump Gender Statistics

  • name:

dgenstats

Generate Testcases for Persons and Families

Generates a (seeded) randomized tree to allow specific error conditions to be tested. The issues it generates can be corrected via the 'Check and Repair' tool.

Usage

  • name:

testcasegenerator

Parameters

  • add_linebreak: =0/1
    Whether to add a line break to every text field
    • No linebreak
    • Add line break
  • person_count: =int
    Number of dummy persons to generate
    • Value: Number of persons
  • no_trans: =0/1
    Whether to use one transaction or multiple small ones
    • One transaction
    • Multiple transactions
  • long_names: =0/1
    Whether to create short or long names
    • Short names
    • Long names
  • bugs: =0/1
    Whether to create invalid database references.
    • Skip test
    • Create invalid Database references
  • persons: =0/1
    Whether to create a bunch of dummy persons
    • Don't create persons
    • Create dummy persons
  • add_serial: =0/1
    Whether to add a serial number to every text field
    • No serial
    • Add serial number
  • specialchars: =0/1
    Whether to add some special characters to every text field
    • No special characters
    • Add special characters

Verify the Data

  • name:

verify

  • lngwdw: =num

Maximum number of consecutive years of widowhood before next marriage

Value: Number of years

  • mxchildmom: =num

Maximum number of children for a woman

Value: Number of children

  • wedder: =num

Maximum number of spouses for a person

Value: Number of spouses

  • oldunm: =num

Maximum age for an unmarried personNumber of years

  • mxchilddad: =num

Maximum number of children for a man

Value: Number of chidlren

  • estimate_age: =0/1

Whether to estimate missing dates

Do not estimate

Estimate dates

  • yngmar: =num

Minimum age to marry

Value: Age in years

  • oldmar: =num

Maximum age to marry

Value: Age in years

  • cbspan: =num

Maximum span of years for all children

Value: Span in years

  • oldage: =num

Maximum age

Value: Age in years

  • olddad: =num

Maximum age to father a child

Value: Age in years

  • hwdif: =num

Maximum husband-wife age difference

Value: Age difference in years

  • invdate: =0/1

Whether to check for invalid datesDo not identify invalid dates

Value: Identify invalid dates

  • yngmom: =num

Minimum age to bear a child

Value: Age in years

  • yngdad: =num

Minimum age to father a child

Value: Age in years

  • oldmom: =num

Maximum age to bear a child

Value: Age in years

  • cspace: =num

Maximum number of years between children

Value: Number of years

Rebuild Secondary Indices

  • name:

rebuild

Generate Commandline Plugin Reference

  • name:

cmdref

  • include: =0/1

Whether to include into the manual

Do not include

Include

  • target: =str

Pathname to the target file

Value: Any valid pathname

Reorder Gramps IDs

  • name:

reorder_ids