From 2dda2301f0c1bbbd341c34c60d9ccb87ccee42ca Mon Sep 17 00:00:00 2001 From: Anthony D'Atri Date: Mon, 22 May 2023 15:06:12 -0400 Subject: [PATCH] Recast README into MarkDown with various minor corrections and improvements Signed-off-by: Anthony D'Atri --- Makefile | 4 +- README | 125 ------------------------------------------- README.md | 156 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 158 insertions(+), 127 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/Makefile b/Makefile index 24e70ab..8f4410e 100644 --- a/Makefile +++ b/Makefile @@ -61,7 +61,7 @@ release-dir: mkdir -p $(VERSIONED_NAME) release-cp: release-dir - cp -a AUTHORS COPYING INSTALL README $(VERSIONED_NAME) + cp -a AUTHORS COPYING INSTALL README.md $(VERSIONED_NAME) cp -a tuned.py tuned.spec tuned.service tuned.tmpfiles Makefile tuned-adm.py \ tuned-adm.bash dbus.conf recommend.conf tuned-main.conf 00_tuned \ @@ -209,7 +209,7 @@ install: install-dirs # documentation cp -a doc/README* $(DESTDIR)$(DOCDIR) cp -a doc/*.txt $(DESTDIR)$(DOCDIR) - cp AUTHORS COPYING README $(DESTDIR)$(DOCDIR) + cp AUTHORS COPYING README.md $(DESTDIR)$(DOCDIR) # libexec scripts $(foreach file, $(wildcard libexec/*), \ diff --git a/README b/README deleted file mode 100644 index a8043ca..0000000 --- a/README +++ /dev/null @@ -1,125 +0,0 @@ -TuneD: Daemon for monitoring and adaptive tuning of system devices. - -(This is tuned 2.0 with a new code base. If you are looking for the older -version, please check out branch '1.0' in our Git repository.) - -How to use it -------------- - -TuneD is incompatible with the cpupower and power-profiles-daemon. If you -have these services, uninstall or disable them. - -In Fedora, Red Hat Enterprise Linux, and their derivates install tuned package -(optionally tuned-utils, tuned-utils-systemtap, and tuned-profiles-compat): - -# dnf install tuned - -After the installation, start the tuned service: - -# systemctl start tuned - -You might also want to run tuned whenever your machine starts: - -# systemctl enable tuned - -If the daemon is running you can easily control it using 'tuned-adm' command -line utility. This tool communicates with the daemon over DBus. Any user can -list the available profiles and see which one is active. But the profiles can -be switched only by root user or by any user with physical console allocated -on the machine (X11, physical tty, but no SSH). - -To see the current active profile, run: - -# tuned-adm active - -To list all available profiles, run: - -# tuned-adm list - -To switch to a different profile, run: - -# tuned-adm profile - -Your profile choice is also written into /etc/tuned/active_profile and this -choice is used when the daemon is restarted (e.g. with the machine reboot). - -To disable all tunings, run: -# tuned-adm off - -To show information/description of given profile or current profile if no profile is specified, run: -# tuned-adm profile_info - -To verify current profile against system settings, run: -# tuned-adm verify - -To enable automatic profile selection mode, switch to the recommended profile, run: -# tuned-adm auto_profile - -To show current profile selection mode, run: -# tuned-adm profile_mode - -# tuned-adm recommend -Recommend profile suitable for your system. Currently only static detection is -implemented - it decides according to data in /etc/system-release-cpe and -virt-what output. The rules for autodetection are defined in the file -/usr/lib/tuned/recommend.d/50-tuned.conf. They can be overridden by the user by -putting a file to /etc/tuned/recommend.d or a file named recommend.conf into -/etc/tuned (see tuned-adm(8) for more details). The default rules recommend -profiles targeted to the best performance or the balanced profile if unsure. - -Available tunings ------------------ - -We are currently working on many new tuning features. Some are described in -the manual pages, some are yet undocumented. - - -Authors -------- - -The best way to contact the authors of the project is to use our mailing list: -power-management@lists.fedoraproject.org - -In case you want to contact individual author, you will find the e-mail -address in every commit message in our Git repository: -https://github.com/redhat-performance/tuned.git - -You can also join #fedora-power IRC channel on Freenode. - -Web page: -https://tuned-project.org/ - -Contributing ------------- -See the file CONTRIBUTING.md for guidelines for contributing. - -License -------- - -Copyright (C) 2008-2021 Red Hat, Inc. - -This program is free software; you can redistribute it and/or -modify it under the terms of the GNU General Public License -as published by the Free Software Foundation; either version 2 -of the License, or (at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - -Full text of the license is enclosed in COPYING file. - -The Developer Certificate of Origin, distributed in the file 'DCO' is licensed -differently, see the file for the text of the license. - - -The icon: - -The TuneD icon was created by Mariia Leonova and it is -licensed under Creative Commons Attribution-ShareAlike 3.0 license -(http://creativecommons.org/licenses/by-sa/3.0/legalcode). diff --git a/README.md b/README.md new file mode 100644 index 0000000..b25aaab --- /dev/null +++ b/README.md @@ -0,0 +1,156 @@ +# TuneD: Daemon for monitoring and adaptive tuning of system devices. + +(This is TuneD 2.0 with a new code base. If you are looking for the older +version, please check out branch '1.0' in our Git repository.) + +How to use it +------------- + +TuneD is incompatible with ``cpupower`` and ``power-profiles-daemon``. If you +have these services, uninstall or disable them. + +On Fedora, Red Hat Enterprise Linux, and their derivatives: install the ``tuned`` package +(optionally ``tuned-utils``, ``tuned-utils-systemtap``, and ``tuned-profiles-compat``): + +```bash + # dnf install tuned +``` + +After installation, start the ``tuned`` service: + +```bash + # systemctl start tuned +``` + +You likely should run ``tuned`` whenever your machine boots: + +```bash + # systemctl enable tuned +``` + +When the daemon is running you can easily control it using the ``tuned-adm`` +utility. This tool communicates with the daemon over DBus. Any user can +list the available profiles and see which one is active. The active profile can +be switched only by root user or by any user with physical console allocated +on the machine (X11, physical tty, but no SSH). + +To see the current active profile, run: + +```bash + # tuned-adm active +``` + +To list all available profiles, run: + +```bash + # tuned-adm list +``` + +To switch to a different profile, run: + +```bash + # tuned-adm profile +``` + +The enabled profile is persisted into ``/etc/tuned/active_profile``, which +is read when the daemon starts or is restarted. + +To disable all tunings, run: + +```bash + # tuned-adm off +``` + +To show information/description of given profile or current profile if no profile is specified, run: + +```bash + # tuned-adm profile_info +``` + +To verify current profile against system settings, run: + +```bash + # tuned-adm verify +``` + +To enable automatic profile selection, run: + +```bash + # tuned-adm auto_profile +``` + +To show the current profile selection mode, run: + +```bash + # tuned-adm profile_mode +``` + +To recommend a profile for a given system, run: + +```bash + # tuned-adm recommend +``` +Currently only static detection is +implemented - it decides according to data in ``/etc/system-release-cpe`` and +the output of ``virt-what``. The rules for autodetection are defined in the file +``/usr/lib/tuned/recommend.d/50-tuned.conf``. They can be overridden by the user by +creating a file in ``/etc/tuned/recommend.d`` or a file named ``recommend.conf`` in +``/etc/tuned``. See the ``tuned-adm(8)`` man page for details). The default rules +recommend profiles targeted to the best performance or the balanced profile if unsure. + +Available tunings +----------------- + +We are currently working on many new tuning features. Some are described in +the manual pages, some are yet undocumented. + + +Authors +------- + +The best way to contact the authors of the project is to use our mailing list: + + +If you want to contact an individual author, you will find their e-mail +address in every commit message in our Git repository: + + +You can also join the ``#fedora-power`` IRC channel on Freenode. + +Web page: + + +Contributing +------------ +See the file ``CONTRIBUTING.md`` for guidelines for contributing. + +License +------- + +Copyright (C) 2008-2021 Red Hat, Inc. + +This program is free software; you can redistribute it and/or +modify it under the terms of the GNU General Public License +as published by the Free Software Foundation; either version 2 +of the License, or (at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + +Full text of the license is enclosed in COPYING file. + +The Developer Certificate of Origin, distributed in the file 'DCO' is licensed +differently, see the file for the text of the license. + + +The icon: + +The TuneD icon was created by Mariia Leonova and it is +licensed under Creative Commons Attribution-ShareAlike 3.0 license +(http://creativecommons.org/licenses/by-sa/3.0/legalcode).