source: subversion/applications/utils/revert/README @ 29923

Last change on this file since 29923 was 28020, checked in by pnorman, 8 years ago

Add the name of the configuration file to the README from the wiki

File size: 3.0 KB
Line 
1The scripts in this directory together form the "osmtools" suite.
2Originally written by Frederik Ramm <frederik@remote.org>, public domain.
3
4The scripts require Perl and the LWP module (libwww-perl on Ubuntu et al.).
5
6PACKAGE CONTENTS
7----------------
8
9changeset.pl / Changeset.pm -- opens and closes changesets
10undo.pl      / Undo.pm      -- undoes one change to one object
11undelete.pl  / Undelete.pm  -- undeletes an object; see comment in-file
12                               for differences to undo
13revert.pl    / Revert.pm    -- reverts a whole changeset
14
15DESIGN "PHILOSOPHY"
16-------------------
17
18Most functionality is implemented as individual Perl modules (.pm). They do
19not have a namespace because we want people to be able to run everything
20from the current directory. If you create a Perl module named "Osm::Api",
21then it has to reside in a subdirectory named "Osm" which tends to get
22confusing, at least for me.
23
24We're not using any libraries for XML reading and writing, just plain regular
25expressions.
26
27We're not creating any OO interfaces.
28
29In addition to the modules, there are simple perl scripts (.pl) that can
30be called from the command line and that provide a command line interface
31to what the modules do.
32
33If you want to create some hyper cool object oriented undo/redo manager
34using all the latest libraries and technologies and design patterns,
35feel free to cannibalize the hell out of this code and make your own.
36
37ACT RESPONSIBLY
38---------------
39
40These scripts enable you to revert edits done by other people. Never do this
41unless you are absolutely sure that the edit in question is either malicious
42or accidental. Make an effort to talk to the user beforehand and afterwards.
43Always be kind to other mappers, and always assume that if they did something
44wrong it must have been an error, a misunderstanding, or their cat chasing
45fluff across the keyboard!
46
47When in doubt, discuss things on the mailing list before you act (see
48lists.openstreetmap.org). Also, read the WIki article on automated
49edits here: http://wiki.openstreetmap.org/wiki/Automated_Edits.
50
51These scripts do not have safety nets. Be sure that you feel confident to
52fix anything you might break. If you do not know your PUTs from your GETs,
53if you do not know the details of API 0.6, or know what changesets are
54and how they work, then DO NOT USE THIS SOFTWARE.
55
56CONFIGURATION
57-------------
58
59You will have to create a file named .osmtoolsrc in your home directory
60containg your user name, password, and the URL of the OSM server to use. The
61URL must be complete up to the API version number and the slash afterwards, so:
62
63username=fred
64password=test
65apiurl=http://api06.dev.openstreetmap.org/api/0.6/
66
67By default, all tools will run in "dry run" mode, so no changes will
68be actually written and all write requests will be considered successful.
69Add the "dryrun=0" parameter to the file for live action.
70
71By default, "dry run" also enables "debug" so you are shown the requests
72made. If you want to keep debug mode when setting dryrun=0, explicitly
73set debug=1.
74
Note: See TracBrowser for help on using the repository browser.