diff options
| author | David Edmundson <kde@davidedmundson.co.uk> | 2013-10-31 18:04:38 +0100 |
|---|---|---|
| committer | David Edmundson <kde@davidedmundson.co.uk> | 2013-11-04 12:13:03 +0100 |
| commit | c4a1d70dc4e8501fbbfeec287bc06d30223f15b4 (patch) | |
| tree | 09f4cb5e7bf80c4d12ee171de4181d724765da9c /modules/ECMInstallIcons.cmake | |
| parent | 6d249fc08537655098b68bf2e82d261ca764ac94 (diff) | |
| download | extra-cmake-modules-c4a1d70dc4e8501fbbfeec287bc06d30223f15b4.tar.gz extra-cmake-modules-c4a1d70dc4e8501fbbfeec287bc06d30223f15b4.tar.bz2 | |
Improve documentation in ECMInstallIcons.cmake
REVIEW: 113522
Diffstat (limited to 'modules/ECMInstallIcons.cmake')
| -rw-r--r-- | modules/ECMInstallIcons.cmake | 31 |
1 files changed, 29 insertions, 2 deletions
diff --git a/modules/ECMInstallIcons.cmake b/modules/ECMInstallIcons.cmake index 11148050..6f725da2 100644 --- a/modules/ECMInstallIcons.cmake +++ b/modules/ECMInstallIcons.cmake @@ -1,8 +1,35 @@ # - Function for installing icons # This module provides the function ECM_INSTALL_ICONS(). -# ECM_INSTALL_ICONS installs all icons in the current path -# into the diectory provided. +# ECM_INSTALL_ICONS installs all icons in the current path that +# match a specific file naming convention into into the directory provided +# following the Freedesktop.org icon naming spec +# http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html + +# The files in the directory must be in the format in order to be installed +# themeSize-Group-name.extension + +# The following file extensions are supported +# .png +# .mng +# .svgz + +# Where the theme is one of: +# "hi" for hicolor +# "lo" for locolor +# "cr" for the crystal icon theme +# "ox" for the oxygen icon theme + +# Size refers to the size of one dimension of the icon +# Typically, 16, 22, 32, 48, 64, 128 or 256 +# For svgz files the size should be set to "sc" + +# For example the file +# hi22-action-menu_new.png +# would be installed into +# PREFIX/hicolor/22x22/actions/menu_new.png + + # a "map" of short type names to the directories # unknown names should give empty results |