I wanted to check the syntax of something in one of my packages, and rather than hunt for the file on my system I just did texdoc hobby on the command line. To my dismay, this brought up the PDF containing the code, not the main documentation. When I submitted the package to CTAN, I split the documentation into two parts: the user documentation and the code documentation. As the latter is produced from the .dtx, it gets named hobby.pdf, the user documentation can be named whatever I like so I chose hobby_doc.pdf. It's quite reasonable that texdoc hobby produces hobby.pdf (and texdoc hobby_doc produces the user documentation), but that doesn't seem like the right thing to do from a user's perspective.

There seem to me to be two ways to fix this:

  1. Change my filenames so that the code becomes hobby_code.pdf and the documentation is hobby.pdf. Ideally, I'd like this to be automatic so that I still have hobby.dtx and hobby.tex but pdflatex hobby.dtx produces hobby_code.pdf. I know that one can't change \jobname from within a document, but as this is a .dtx, I thought that maybe the compilation process isn't as simple as it seems and it might still be possible to change the output filename. Is it?

  2. Set up texdoc so that texdoc hobby points to hobby_doc.pdf. This, as I understand it, is eminently possible but it would need doing officially. So how do I go about making such a change and is it a simple thing to ask for? (If complicated, then clearly I should use Option 1 even if I can't do so automatically.)

  • What does texdoc -l hobby report? I assume the TL team have spotted both. – Joseph Wright May 8 '14 at 7:59
  • When I type texdoc hobby I see hobby_doc.pdf. As I haven't updated my packages in a few months, perhaps something in one of the updates caused this. – Peter Grill May 8 '14 at 8:02
  • @JosephWright It reports (in order) hobby.pdf, hobby_doc.pdf, and README. I presume that this part is automatic in that it looks for all pdfs (and other standard files) in the submitted doc directory. My point about my parenthetical remark is that I don't want to make a nuisance of myself with the CTAN/TL team, so if there's a "right" way to do this then I'll follow that. – Andrew Stacey May 8 '14 at 8:02
  • I get this from texdoc hobby: i.stack.imgur.com/WcTMs.png and through winedt help menu this: i.stack.imgur.com/bs0Rw.png – user11232 May 8 '14 at 8:10
  • 2
    From time to time there are requests on the TL-list to set another default for texdoc for a specific package (because of similar »wrong« default documentation). I guess you could do the same – cgnieder May 8 '14 at 9:23

I've seen requests from time to time on the Tex Live list by authors as well as by users to set another default for texdoc for a specific package (because of similarly »wrong« default documentation). You probably could do the same.

| improve this answer | |

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.