Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

unix man pages are not fully branded #2153

Closed
jnweiger opened this issue Sep 3, 2014 · 9 comments
Closed

unix man pages are not fully branded #2153

jnweiger opened this issue Sep 3, 2014 · 9 comments

Comments

@jnweiger
Copy link
Contributor

jnweiger commented Sep 3, 2014

genbranding.pl renames the man pages, but the contents always speaks of OWNCLOUD, ownCloud, owncloud. No templates apply.

@jnweiger
Copy link
Contributor Author

Hmm, do we apply branding when the documentation speaks about 'the ownCloud server' ?

@danimo Sphinx should be able to do variable substitution while building the documentation. Do we have an example?

@hodyroff
Copy link

hodyroff commented Dec 8, 2016

oh mighty. @michaelstingl
Honestly I would just have an option to delete those man pages if so desired, but I don't know if thats more difficult then putting $name or something into them ... there are some borders to branding maybe ;)

@michaelstingl
Copy link
Contributor

@guruz Is it easy to add the branding variables here?

@guruz
Copy link
Contributor

guruz commented Dec 8, 2016

@michaelstingl afaik you need to replace it with a $FILENAME.in (or .cmake) file and then add a link in the CMakeFiles.txt to have cmake process the file when copying it.
You can look at how it is done for admin/osx/post_install.sh.cmake

@michaelstingl
Copy link
Contributor

Who can fix it? @SamuAlfageme ?

@SamuAlfageme
Copy link
Contributor

SamuAlfageme commented Dec 27, 2016

Yes, I can make a small patch to use the $APPLICATION_EXECUTABLE[cmd] in the manpages, and expand it with Sphinx, it should be that easy.

But my real concern is that these are currently not being copied/linked to /usr/[local/]share/man/man1/ in any [post]installation script (or at least I can't see where; also tried installing owncloud through APT in ubuntu and no luck with it).

btw, the pages seem to be a bit outdated/incomplete:

@guruz
Copy link
Contributor

guruz commented Jan 2, 2017

I don't even think you need Sphinx, you can do it analog to what I described above: #2153 (comment)

@hodyroff
Copy link

If you like we can also get rid of the man pages completely ... but lets decide on one direction and get it done for 2.4.

@hodyroff hodyroff added this to the 2.4.0 milestone Mar 13, 2017
@jnweiger
Copy link
Contributor Author

jnweiger commented Mar 24, 2017

Manpages are unmaintained for long. To be removed from templates v2.3.2 and up.

  • remove doc-man target in doc/CMakeLists.txt
  • make have_doc (html dokumentation) independant of man pages generation
  • prevent packaging of man pages in DEB/RPM

jnweiger added a commit to owncloud/administration that referenced this issue Mar 24, 2017
jnweiger added a commit to owncloud/administration that referenced this issue Mar 24, 2017
jnweiger added a commit that referenced this issue Mar 24, 2017
remove doc-man target in doc/CMakeLists.txt #2153
guruz pushed a commit that referenced this issue Mar 24, 2017
remove doc-man target in doc/CMakeLists.txt #2153
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants