osmium-time-filter(1)

1OSMIUM-TIME-FILTER(1)                                    OSMIUM-TIME-FILTER(1)
2
3
4

NAME

6       osmium-time-filter - filter OSM data by time from a history file
7

SYNOPSIS

9       osmium time-filter [OPTIONS] OSM-HISTORY-FILE [TIME]
10       osmium time-filter [OPTIONS] OSM-HISTORY-FILE FROM-TIME TO-TIME
11

DESCRIPTION

13       Copy  all  objects that were valid at the given TIME or in the time pe‐
14       riod between FROM-TIME (inclusive) and TO-TIME (not inclusive) from the
15       input file into the output file.  If no time is given, the current time
16       is used.
17
18       Usually the INPUT-FILE will be an OSM data file with history.  If  both
19       FROM-TIME  and  TO-TIME  are  given,  the result will also have history
20       data, it will also include deleted versions of objects.
21
22       If only a single point in time was given, the result will be  a  normal
23       OSM file without history containing no deleted objects.
24
25       The format for the timestamps is “yyyy-mm-ddThh:mm:ssZ”.
26
27       This commands reads its input file only once and writes its output file
28       in one go so it can be streamed, ie.  it can read from STDIN and  write
29       to STDOUT.
30

COMMON OPTIONS

32       -h, --help
33              Show usage help.
34
35       -v, --verbose
36              Set  verbose  mode.   The  program will output information about
37              what it is doing to STDERR.
38
39       --progress
40              Show progress bar.  Usually a progress bar is only displayed  if
41              STDOUT  and  STDERR  are detected to be TTY.  With this option a
42              progress bar is always shown.  Note that  a  progress  bar  will
43              never be shown when reading from STDIN or a pipe.
44
45       --no-progress
46              Do  not  show progress bar.  Usually a progress bar is displayed
47              if STDOUT and STDERR are detected to be a TTY.  With this option
48              the  progress  bar is suppressed.  Note that a progress bar will
49              never be shown when reading from STDIN or a pipe.
50

INPUT OPTIONS

52       -F, --input-format=FORMAT
53              The format of the input file(s).  Can be used to set  the  input
54              format  if it can’t be autodetected from the file name(s).  This
55              will set the format for all input files, there is no way to  set
56              the  format  for  some  input  files only.  See osmium-file-for‐
57              mats(5) or the libosmium manual for details.
58

OUTPUT OPTIONS

60       -f, --output-format=FORMAT
61              The format of the output file.  Can be used to  set  the  output
62              file  format  if  it  can’t be autodetected from the output file
63              name.  See osmium-file-formats(5) or the  libosmium  manual  for
64              details.
65
66       --fsync
67              Call  fsync after writing the output file to force flushing buf‐
68              fers to disk.
69
70       --generator=NAME
71              The name and version of the program generating the output  file.
72              It  will  be added to the header of the output file.  Default is
73              “osmium/” and the version of osmium.
74
75       -o, --output=FILE
76              Name of the output file.  Default is `-' (STDOUT).
77
78       -O, --overwrite
79              Allow an existing output file to be overwritten.   Normally  os‐
80              mium will refuse to write over an existing file.
81
82       --output-header=OPTION=VALUE
83              Add  output header option.  This command line option can be used
84              multiple times for different OPTIONs.   See  the  osmium-output-
85              headers(5) man page for a list of available header options.  For
86              some commands you can use the special format “OPTION!” (ie.   an
87              exclamation  mark  after the OPTION and no value set) to set the
88              value to the same as in the input file.
89

DIAGNOSTICS

91       osmium time-filter exits with exit code
92
93       0      if everything went alright,
94
95       1      if there was an error processing the data, or
96
97       2      if there was a problem with the command line arguments.
98

MEMORY USAGE

100       osmium time-filter does all its work on the fly and doesn’t  keep  much
101       data in main memory.
102

EXAMPLES

104       Extract current planet file from history planet:
105
106              osmium time-filter -o planet.osm.pbf history-planet.osh.pbf
107
108       Extract  planet  data  how  it  appeared on January 1 2008 from history
109       planet:
110
111              osmium time-filter -o planet-20080101.osm.pbf history-planet.osh.pbf 2008-01-01T00:00:00Z
112

COPYRIGHT

119       Copyright (C) 2013-2023 Jochen Topf <jochen@topf.org>.
120
121       License  GPLv3+:  GNU  GPL  version  3  or  later  <https://gnu.org/li‐
122       censes/gpl.html>.   This  is  free software: you are free to change and
123       redistribute it.  There is NO WARRANTY, to the extent permitted by law.
124

CONTACT

126       If you have any questions or  want  to  report  a  bug,  please  go  to
127       https://osmcode.org/contact.html
128

AUTHORS

130       Jochen Topf <jochen@topf.org>.
131
132
133
134                                    1.16.0               OSMIUM-TIME-FILTER(1)