g.rename
Renames data base element files in the user's current mapset.
g.rename [raster=from,to] [raster_3d=from,to] [vector=from,to] [label=from,to] [region=from,to] [group=from,to] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]
Example:
g.rename
grass.script.run_command("g.rename", raster=None, raster_3d=None, vector=None, label=None, region=None, group=None, overwrite=False, verbose=False, quiet=False, superquiet=False)
Example:
gs.run_command("g.rename")
Parameters
raster=from,to
raster map(s) to be renamed
raster_3d=from,to
3D raster map(s) to be renamed
vector=from,to
vector map(s) to be renamed
label=from,to
paint label file(s) to be renamed
region=from,to
region definition(s) to be renamed
group=from,to
imagery group(s) to be renamed
--overwrite
Allow output files to overwrite existing files
--help
Print usage summary
--verbose
Verbose module output
--quiet
Quiet module output
--qq
Very quiet module output
--ui
Force launching GUI dialog
raster : tuple[str, str] | list[str] | str, optional
raster map(s) to be renamed
Used as: input, raster, from,to
raster_3d : tuple[str, str] | list[str] | str, optional
3D raster map(s) to be renamed
Used as: input, 3D raster, from,to
vector : tuple[str, str] | list[str] | str, optional
vector map(s) to be renamed
Used as: input, vector, from,to
label : tuple[str, str] | list[str] | str, optional
paint label file(s) to be renamed
Used as: input, label, from,to
region : tuple[str, str] | list[str] | str, optional
region definition(s) to be renamed
Used as: input, region definition, from,to
group : tuple[str, str] | list[str] | str, optional
imagery group(s) to be renamed
Used as: input, imagery group, from,to
overwrite: bool, optional
Allow output files to overwrite existing files
Default: False
verbose: bool, optional
Verbose module output
Default: False
quiet: bool, optional
Quiet module output
Default: False
superquiet: bool, optional
Very quiet module output
Default: False
DESCRIPTION
g.rename allows the user to rename data base element files in the user's current mapset. The user can specify all necessary information to g.rename on the command line, by specifying: the type of data base element to be renamed (one or more of: raster, raster_3d, vector, icon, labels, region, and group); the specific file element in the current mapset to be renamed (old); and the new name to be assigned to this file element (new) in the current mapset. The file element old is then renamed to new.
Users can also simply type g.rename --help without arguments on the command line, to receive a menu of existing data base element types and files from which to choose for possible renaming:
raster raster map(s) to be renamed
raster_3d 3D raster map(s) to be renamed
vector vector map(s) to be renamed
labels paint label file(s) to be renamed
region region definition(s) to be renamed
group imagery group(s) to be renamed
NOTES
If a data base element has support files (e.g., as is commonly the case with raster maps), these support files also are renamed.
If the user attempts to rename a file to itself by setting the new file name equal to the old file name (e.g., g.rename raster=soils,soils), g.rename will not execute the rename, but instead state that no rename is needed. However, g.rename will allow the user to overwrite other existing files in the current mapset by making the new file name that of an already existing file.
For portability reasons, g.rename is ignoring case of names. To change the case of a map name, first rename the map to a name which differs by more than case, then rename it to the intended name.
EXAMPLE
# rename raster map
g.rename raster=oldrast,newrast
# rename vector map
g.rename vector=oldvect,newvect
# combined renaming
g.rename raster=oldrast,newrast vector=oldvect,newvect
SEE ALSO
AUTHOR
Michael Shapiro, U.S.Army Construction Engineering Research Laboratory
SOURCE CODE
Available at: g.rename source code
(history)
Latest change: Friday Feb 07 19:16:09 2025 in commit a82a39f