I don't think it is necessary to duplicate information from the tool itself into a manual page so a tried to keep the man page simple. This way we will not have to maintain it with any change in sssctl.
If you think it is better to include all commands and options in the man page as well, I can do it...
On (04/07/16 12:21), Pavel Březina wrote:
I don't think it is necessary to duplicate information from the tool itself into a manual page so a tried to keep the man page simple. This way we will not have to maintain it with any change in sssctl.
If you think it is better to include all commands and options in the man page as well, I can do it...
From 5c8005bab6c82d4723ae9ed7583b88b3874a260b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pavel=20B=C5=99ezina?= pbrezina@redhat.com Date: Mon, 4 Jul 2016 12:19:37 +0200 Subject: [PATCH] sssctl: manual page
Resolves: https://fedorahosted.org/sssd/ticket/3055
contrib/sssd.spec.in | 1 + src/man/Makefile.am | 2 +- src/man/sssctl.8.xml | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 71 insertions(+), 1 deletion(-) create mode 100644 src/man/sssctl.8.xml
diff --git a/contrib/sssd.spec.in b/contrib/sssd.spec.in index b8a9efc07e2cb9325b5d445d546ec145391b95c2..d5730a474eb554fa81123e03b1815d2a71da7496 100644 --- a/contrib/sssd.spec.in +++ b/contrib/sssd.spec.in @@ -950,6 +950,7 @@ done %{_mandir}/man8/sss_override.8* %{_mandir}/man8/sss_debuglevel.8* %{_mandir}/man8/sss_seed.8* +%{_mandir}/man8/sssctl.8*
%files -n python-sssdconfig -f python2_sssdconfig.lang %defattr(-,root,root,-) diff --git a/src/man/Makefile.am b/src/man/Makefile.am index 433d1cddcca75c35b38846e97e455765fe99f77c..cd23b02f6db05dd5f08b6764df4663eafc6f6e7a 100644 --- a/src/man/Makefile.am +++ b/src/man/Makefile.am @@ -51,7 +51,7 @@ man_MANS = \ sssd-krb5.5 sssd-simple.5 \ sssd_krb5_locator_plugin.8 sss_groupshow.8 \ pam_sss.8 sss_obfuscate.8 sss_cache.8 sss_debuglevel.8 sss_seed.8 \
- sss_override.8 idmap_sss.8 \
- sss_override.8 idmap_sss.8 sssctl.8 \ $(NULL)
if BUILD_SAMBA diff --git a/src/man/sssctl.8.xml b/src/man/sssctl.8.xml
I think you will also need to add this file to src/man/po/po4a.cfg otherwise it could not be translated.
I let review of man page to a native speaker.
LS
On 07/04/2016 12:26 PM, Lukas Slebodnik wrote:
On (04/07/16 12:21), Pavel Březina wrote:
I don't think it is necessary to duplicate information from the tool itself into a manual page so a tried to keep the man page simple. This way we will not have to maintain it with any change in sssctl.
+1
I let the review for a native speaker, but having a simple man page and a help for each command instead of maintaining the same info on two places is IMO good idea.
If you think it is better to include all commands and options in the man page as well, I can do it...
From 5c8005bab6c82d4723ae9ed7583b88b3874a260b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pavel=20B=C5=99ezina?= pbrezina@redhat.com Date: Mon, 4 Jul 2016 12:19:37 +0200 Subject: [PATCH] sssctl: manual page
Resolves: https://fedorahosted.org/sssd/ticket/3055
contrib/sssd.spec.in | 1 + src/man/Makefile.am | 2 +- src/man/sssctl.8.xml | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 71 insertions(+), 1 deletion(-) create mode 100644 src/man/sssctl.8.xml
diff --git a/contrib/sssd.spec.in b/contrib/sssd.spec.in index b8a9efc07e2cb9325b5d445d546ec145391b95c2..d5730a474eb554fa81123e03b1815d2a71da7496 100644 --- a/contrib/sssd.spec.in +++ b/contrib/sssd.spec.in @@ -950,6 +950,7 @@ done %{_mandir}/man8/sss_override.8* %{_mandir}/man8/sss_debuglevel.8* %{_mandir}/man8/sss_seed.8* +%{_mandir}/man8/sssctl.8*
%files -n python-sssdconfig -f python2_sssdconfig.lang %defattr(-,root,root,-) diff --git a/src/man/Makefile.am b/src/man/Makefile.am index 433d1cddcca75c35b38846e97e455765fe99f77c..cd23b02f6db05dd5f08b6764df4663eafc6f6e7a 100644 --- a/src/man/Makefile.am +++ b/src/man/Makefile.am @@ -51,7 +51,7 @@ man_MANS = \ sssd-krb5.5 sssd-simple.5 \ sssd_krb5_locator_plugin.8 sss_groupshow.8 \ pam_sss.8 sss_obfuscate.8 sss_cache.8 sss_debuglevel.8 sss_seed.8 \
- sss_override.8 idmap_sss.8 \
- sss_override.8 idmap_sss.8 sssctl.8 \ $(NULL)
if BUILD_SAMBA diff --git a/src/man/sssctl.8.xml b/src/man/sssctl.8.xml
I think you will also need to add this file to src/man/po/po4a.cfg otherwise it could not be translated.
I let review of man page to a native speaker.
LS _______________________________________________ sssd-devel mailing list sssd-devel@lists.fedorahosted.org https://lists.fedorahosted.org/admin/lists/sssd-devel@lists.fedorahosted.org
On 07/04/2016 12:26 PM, Lukas Slebodnik wrote:
On (04/07/16 12:21), Pavel Březina wrote:
I don't think it is necessary to duplicate information from the tool itself into a manual page so a tried to keep the man page simple. This way we will not have to maintain it with any change in sssctl.
If you think it is better to include all commands and options in the man page as well, I can do it...
From 5c8005bab6c82d4723ae9ed7583b88b3874a260b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pavel=20B=C5=99ezina?= pbrezina@redhat.com Date: Mon, 4 Jul 2016 12:19:37 +0200 Subject: [PATCH] sssctl: manual page
Resolves: https://fedorahosted.org/sssd/ticket/3055
contrib/sssd.spec.in | 1 + src/man/Makefile.am | 2 +- src/man/sssctl.8.xml | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 71 insertions(+), 1 deletion(-) create mode 100644 src/man/sssctl.8.xml
diff --git a/contrib/sssd.spec.in b/contrib/sssd.spec.in index b8a9efc07e2cb9325b5d445d546ec145391b95c2..d5730a474eb554fa81123e03b1815d2a71da7496 100644 --- a/contrib/sssd.spec.in +++ b/contrib/sssd.spec.in @@ -950,6 +950,7 @@ done %{_mandir}/man8/sss_override.8* %{_mandir}/man8/sss_debuglevel.8* %{_mandir}/man8/sss_seed.8* +%{_mandir}/man8/sssctl.8*
%files -n python-sssdconfig -f python2_sssdconfig.lang %defattr(-,root,root,-) diff --git a/src/man/Makefile.am b/src/man/Makefile.am index 433d1cddcca75c35b38846e97e455765fe99f77c..cd23b02f6db05dd5f08b6764df4663eafc6f6e7a 100644 --- a/src/man/Makefile.am +++ b/src/man/Makefile.am @@ -51,7 +51,7 @@ man_MANS = \ sssd-krb5.5 sssd-simple.5 \ sssd_krb5_locator_plugin.8 sss_groupshow.8 \ pam_sss.8 sss_obfuscate.8 sss_cache.8 sss_debuglevel.8 sss_seed.8 \
- sss_override.8 idmap_sss.8 \
- sss_override.8 idmap_sss.8 sssctl.8 \ $(NULL)
if BUILD_SAMBA diff --git a/src/man/sssctl.8.xml b/src/man/sssctl.8.xml
I think you will also need to add this file to src/man/po/po4a.cfg otherwise it could not be translated.
Added, thanks.
I let review of man page to a native speaker.
CCed Dan.
sssd-devel@lists.fedorahosted.org