From 112e35a1b56b87012a40d65f506861c818ba35b2 Mon Sep 17 00:00:00 2001 From: Landon Curt Noll Date: Tue, 16 Apr 2024 21:49:53 -0700 Subject: [PATCH] fix formatting of faq.html Attempted to fix formatting problems of `faq.html` that was introduced in commit 476b0d45f0dede76ad22c6b3880f1aee5051a6c6. Run `make gen_top_html` to perform the above and test under macOS. --- faq.html | 210 ++++++++++++---------------------- faq.md | 342 +++++++++++++++++++++++++++++++++++++++++++------------ 2 files changed, 342 insertions(+), 210 deletions(-) diff --git a/faq.html b/faq.html index 0336f99f7..209707fad 100644 --- a/faq.html +++ b/faq.html @@ -217,14 +217,12 @@ other inconsistencies with the original entry?
  • 6.11 - Am I allowed to use IOCCC content?

    • The IOCCC FAQ

    -##
    -Section 0: Submitting entries to a new IOCCC +

    Section 0: Submitting entries to a new IOCCC

    -###
    -FAQ 0.0: How may I submit to the IOCCC? +

    FAQ 0.0: How may I submit to the IOCCC?

    To submit your code to the IOCCC, you MUST follow these steps:

    @@ -286,9 +284,8 @@ on how upload your entry to the IOCCC submit server. Once with the proper instructions. Watch the IOCCC news for an annoucement of the availability of the IOCCC submit server.

    -###
    -FAQ 0.1: What types of entries have been over-submitted to the IOCCC? +

    FAQ 0.1: What types of entries have been over-submitted to the IOCCC?

    There are types of entries that show up over and over again. The IOCCC judges, and we suspect the public that enjoy viewing the @@ -380,9 +377,8 @@ that it is obfuscated in several new and novel ways. Be sure to clearly explain near the beginning of your remarks why you are submitting a entry based on an ‘overused theme’ and why the judges should not simply toss it out as being boring.

    -###
    -FAQ 0.2: What should I put in my entry’s Makefile? +

    FAQ 0.2: What should I put in my entry’s Makefile?

    We recommend starting with the sample Makefile @@ -403,9 +399,8 @@ your Makefile should copy prog.c into the desired file

    For the make(1) connoisseur: As of 2023, IOCCC judges use GNU make compatible make(1) command that is compatible with GNU Make version 3.81.

    -###
    -FAQ 0.3: May I use a different source or compiled filename than prog.c or prog? +

    FAQ 0.3: May I use a different source or compiled filename than prog.c or prog?

    While your entry’s source filename, as submitted, must be prog.c, your entry’s Makefile may copy prog.c to a different filename as part of the compiling/building process. For example:

    @@ -427,9 +422,8 @@ For example:

        different_name: prog
             rm -f $@
             cp -f prog $@
    -###
    -FAQ 0.4: What platform should I assume for my entry? +

    FAQ 0.4: What platform should I assume for my entry?

    Your entry must compile with GCC and run under at least one flavor of UNIX (e.g. Linux or Solaris). To improve chances to win, it should work under both BSD and @@ -438,10 +432,9 @@ If it can compile and run on Windows and/or Mac (see 2000/thadgavin for one example, amongst others), even better. Being able to compile with other compilers like clang is also a good thing.

    -###
    -FAQ 0.5: How may I comment or make a suggestion on IOCCC rules, guidelines and tools? +

    FAQ 0.5: How may I comment or make a suggestion on IOCCC rules, guidelines and tools?

    The IOCCC judges to welcome feedback on the IOCCC @@ -463,14 +456,12 @@ discussion.

    As a very last resort and/or if you feel the need to engage in a private discussion with the IOCCC judges, then see How to contact the IOCCC.

    -##
    -Section 1: History of the IOCCC +

    Section 1: History of the IOCCC

    -###
    -FAQ 1.0: How did the IOCCC get started? +

    FAQ 1.0: How did the IOCCC get started?

    One day (1984 March 23 to be exact), Larry Bassel and I (Landon Curt @@ -528,18 +519,16 @@ and the tradition continues as the longest running contest on the Internet.

    P.S. Part of the inspiration for making the IOCCC a contest goes to the Bulwer-Lytton fiction contest.

    P^2.S. See the overall README for more details.

    -###
    -FAQ 1.1: Why are some years missing IOCCC entries? +

    FAQ 1.1: Why are some years missing IOCCC entries?

    Some years, such as 1997, 1999, 2002-2003, 2007-2010, 2016-2017, 2021-2023, no IOCCC was held.

    While we try to hold the IOCCC every year, sometime the other demands on the IOCCC judges so not permit us to hold a new IOCCC.

    The pause during the 2021-2023 period was due to the IOCCC judges developing tools to make is much more likely for the IOCCC to be held in a yearly basis later on.

    -###
    -FAQ 1.2: What is the history of the IOCCC web site? +

    FAQ 1.2: What is the history of the IOCCC web site?

    In the beginning of www.ioccc.org

    The long history of the official IOCCC web site can be @@ -693,10 +682,9 @@ of the IOCCC winner repo.

    On 202y mm dd, the temporary repo was merged back into the IOCCC winner repo resulting in many, many substantial improvements to the official IOCCC web site.

    -###
    -FAQ 1.3: How has the IOCCC size limit rule changed over the years? +

    FAQ 1.3: How has the IOCCC size limit rule changed over the years?

    The IOCCC size rule has changed over the years.

    @@ -743,18 +731,15 @@ FAQ 1.3: How has the IOCCC size limit rule changed over the years?
  • Rule 2a: 4993
  • Rule 2b: 2503
    • -##
    -Section 2: IOCCC Judging process +

    Section 2: IOCCC Judging process

    -###
    -FAQ 2.0: How many entries do the judges receive for a given IOCCC? +

    FAQ 2.0: How many entries do the judges receive for a given IOCCC?

    By tradition, we do not say.

    -###
    -FAQ 2.1: What should I put in the remarks.md file of my entry? +

    FAQ 2.1: What should I put in the remarks.md file of my entry?

    While you may put in as much or as little as you wish into your entry’s remarks.md file, we do have few important suggestions:

    @@ -789,16 +774,14 @@ rounds; we look at the author name only if an entry wins. See the guidelines if this is not clear!
  • leaving the remark section empty.
    • -###
    -FAQ 2.2: Why don’t you publish entries that do not win? +

    FAQ 2.2: Why don’t you publish entries that do not win?

    Because the publication on the IOCCC site IS the award! Anyone is free to put their IOCCC hopefuls, lookalikes and/or entries that do not win on their web page for everyone to see.

    -###
    -FAQ 2.3: How much time does it take to judge the contest? +

    FAQ 2.3: How much time does it take to judge the contest?

    It takes a fair amount of time to setup, run, answer email, process entries, review entries, trim down the set entries to a set of winning entries, doing the @@ -812,18 +795,16 @@ work as advertised, we might attempt to fix obvious compilation problems or incompatibilities, but no more than that - so be sure that your entry does work on at least a couple different platforms, at least one of them being UNIX or POSIX-conforming.

    -###
    -FAQ 2.4: How many judging rounds do you have? +

    FAQ 2.4: How many judging rounds do you have?

    Are you trying to trick us? :-)

    By tradition, we do not say how many judging rounds we have in a given IOCCC.

    We often report when the IOCCC judges start the 1st round, and when usually report when the IOCCC judges start near final judging rounds, and sometimes we also report when we enter what we believe is the final judging round, so you may guess that we have at least 3 rounds. :-) The actual number of rounds is certainly more than 3.

    -###
    -FAQ 2.5: Why do some IOCCC entries receive the Grand Prize or Best of Show award? +

    FAQ 2.5: Why do some IOCCC entries receive the Grand Prize or Best of Show award?

    In some years, the IOCCC judges discover a truly amazing IOCCC entry that stands out among all of the other IOCCC entries received that year. @@ -859,9 +840,8 @@ from the judges, they used the following awards:

    These could be considered the ‘best entry’ for those years with 1 or more other entries that came in close behind.

    -###
    -FAQ 2.6: How are IOCCC entries announced? +

    FAQ 2.6: How are IOCCC entries announced?

    Once the IOCCC closes, the judges will:

    -##
    -Section 3: Compiling and running IOCCC entries +

    Section 3: Compiling and running IOCCC entries

    -###
    -FAQ 3.0: What Makefile rules are available to build or clean up IOCCC entries? +

    FAQ 3.0: What Makefile rules are available to build or clean up IOCCC entries?

    In general the best way to compile everything in an entry directory is to run:

        make clobber all
    @@ -914,9 +892,8 @@ gcc-based compiler, or a clang-based compiler, or some other compiler. Only by forcing CC=clang or CC=gcc will one invoke a specific compiler to, say, enable or disable additional warnings or flags. Even so different versions or compilers might do different things, have different defects or other issues.

    -###
    -FAQ 3.1: Why doesn’t this IOCCC entry compile? +

    FAQ 3.1: Why doesn’t this IOCCC entry compile?

    Some entries that won the IOCCC, particularly entries from long ago, no longer compile on more modern systems because the C language has evolved (i.e. the modern C compilers @@ -936,9 +913,8 @@ request for more information about pull requests.

    that works for modern systems but one can view the original code in the .orig.c files (sometimes the original code is also in the directory as a dirname.alt.c or prog.alt.c).

    -###
    -FAQ 3.2: Why does a IOCCC entry fail on my 64-bit system? +

    FAQ 3.2: Why does a IOCCC entry fail on my 64-bit system?

    Unfortunately some older entries are non-portable and require 32-bit support or 32-bit binaries. A problem system here is macOS Catalina (10.15) as as of that @@ -965,9 +941,8 @@ the spirit of the original code are very welcome! Please see FAQ 6.10 How does someone make a change to a file and submit that change as a GitHub pull request for more information about pull requests.

    -###
    -FAQ 3.3: Why do some IOCCC entries fail to compile under macOS? +

    FAQ 3.3: Why do some IOCCC entries fail to compile under macOS?

    If the entry requires gcc and you did not explicitly install gcc in macOS you will not be able to run or use these entries. This is because macOS gcc is @@ -980,9 +955,8 @@ also attempt to preserve the original intent of the IOCCC entry, we would encourage you to submit a pull request with your ported code. Please see FAQ 5.2 How may I submit a fix to an IOCCC entry for details.

    -###
    -FAQ 3.4: Why does clang or gcc fail to compile an IOCCC entry? +

    FAQ 3.4: Why does clang or gcc fail to compile an IOCCC entry?

    Although we have fixed numerous entries to work with clang (sometimes in an alt version but usually in the program itself) there are some that simply cannot be @@ -1002,33 +976,29 @@ form of a pull request. Please see FAQ 5.2 How may I sub entry. See also the FAQ 6.10 How does someone make a change to a file and submit that change as a GitHub pull request for more information about pull requests.

    -###
    -FAQ 3.5: What is this cb tool that is mentioned in the IOCCC? +

    FAQ 3.5: What is this cb tool that is mentioned in the IOCCC?

    This was a C beautifier for Unix, both AT&T and Berkeley, but it seems to no longer be available, code wise, except for Plan 9, but Plan 9 was never used for judging the IOCCC. A Unix man page for cb still exists.

    -###
    -FAQ 3.6: An IOCCC entry messed up my terminal application, how do I fix this? +

    FAQ 3.6: An IOCCC entry messed up my terminal application, how do I fix this?

    The simplest way to do this is to type reset. If echo was disabled you can get usually away with stty echo. Sometimes you can also get away with stty sane. reset does the most but note that it will clear the screen (obviously clear will too but it won’t reset the terminal).

    -###
    -FAQ 3.7: How do I run an IOCCC entry that requires X11? +

    FAQ 3.7: How do I run an IOCCC entry that requires X11?

    -####
    -Generally, to compile and run an IOCCC entry that requires X11: +

    Generally, to compile and run an IOCCC entry that requires X11:

    You must have the X11 related include files and X11 libraries in order to compile the IOCCC entry. In order to do this you will need to install Xorg and @@ -1049,9 +1019,8 @@ further down for different instructions. Otherwise: in particular you must:

  • xterm() terminal application

    • See below for various system related hints that may be of help.

    -####
    -X.org server has been deprecated +

    X.org server has been deprecated

    The Red Hat RHEL9.0 release notes state that X.org Server is now deprecated.

    @@ -1153,10 +1122,9 @@ See the above note for details.

    See the X.org foundation web site.

    IMPORTANT NOTE: The X.org server has been deprecated. See the above note for details.

    -###
    -FAQ 3.8: How do I compile an IOCCC entry that requires SDL1 or SDL2? +

    FAQ 3.8: How do I compile an IOCCC entry that requires SDL1 or SDL2?

    This depends on your operating system but below are instructions for Linux and @@ -1213,10 +1181,9 @@ details. If something is not noted you’re welcome to report it as an issue or fix it and make a new pull request.

    See the FAQ 6.10 How does someone make a change to a file and submit that change as a GitHub pull request for more information about pull requests.

    -###
    -FAQ 3.9: How do I compile an IOCCC entry that requires (n)curses? +

    FAQ 3.9: How do I compile an IOCCC entry that requires (n)curses?

    This depends on your operating system but below are instructions for Linux and @@ -1245,10 +1212,9 @@ packages: one for compiling and one for linking / running.

    Go to the ncurses website and follow their instructions for downloading, installing and using ncurses.

    We recommend trying a method suitable for your environment first, if possible.

    -###
    -FAQ 3.10: How do I compile and use an IOCCC entry that requires sound? +

    FAQ 3.10: How do I compile and use an IOCCC entry that requires sound?

    This might depend on the entry but most likely the Swiss Army Knife of sound @@ -1276,9 +1242,8 @@ include this here, at least for now.

    Other Linux distributions

    Usually the index.html file will explain how to use it under Linux so we do not include this here, at least for now.

    -###
    -FAQ 3.11: Why do Makefiles use -Weverything with clang? +

    FAQ 3.11: Why do Makefiles use -Weverything with clang?

    While we know that use of -Weverything is generally not recommended by clang C compiler developers, we do use the -Weverything @@ -1348,9 +1313,8 @@ differences, try from 1989/westley:

    As you can see, using clang has some additional problems to work out but if you can get your entry to work well in clang it might very well be considered better than other entries.

    -###
    -FAQ 3.12: How do I find out how to send interrupt/EOF etc. for entries that require it? +

    FAQ 3.12: How do I find out how to send interrupt/EOF etc. for entries that require it?

    For some entries one needs to send interrupt or EOF or some other signal/other special characters. There are typical defaults like (where ^ = ctrl):

    @@ -1372,10 +1336,9 @@ to find what the intr is set to:

    … assuming of course that it’s a ctrl combination :-) If for some strange reason it’s not you might have to do something else including just piping it to just grep intr or whatever.

    -###
    -FAQ 3.13: Why does an IOCCC entry fail to compile or or fail run? +

    FAQ 3.13: Why does an IOCCC entry fail to compile or or fail run?

    What may have worked years ago may not work well or work at all today. @@ -1406,10 +1369,9 @@ entry. If so, you are invited to try an fix the IOCCC entry and submit that fix by way of a GitHub pull request. Please see FAQ 5.2 for how to submit a fix to an IOCCC entry.

    -###
    -FAQ 3.14 - How do I compile and install tcpserver for entries that require it? +

    FAQ 3.14 - How do I compile and install tcpserver for entries that require it?

    If your OS package manager does not have the package tcpserver you can @@ -1423,10 +1385,9 @@ like:

        make setup check

    That will install it to /usr/local/bin. Now you should be able to use the entry in question.

    -###
    -3.15 - How do I compile and install netpbm for entries that require it? +

    3.15 - How do I compile and install netpbm for entries that require it?

    This depends on your operating system for which we describe a couple below.

    @@ -1462,10 +1423,9 @@ packages: one for compiling and one for linking / running.

    Go to the netpbm website and follow their instructions for downloading, installing and using netpbm.

    We recommend trying a method suitable for your environment first, if possible.

    -###
    -3.16 - How do I compile and install libjpeg-turbo for entries that require it? +

    3.16 - How do I compile and install libjpeg-turbo for entries that require it?

    This depends on your operating system for which we describe a couple below.

    @@ -1501,10 +1461,9 @@ packages: one for compiling and one for linking / running.

    Go to the libjpeg-turbo website and follow their instructions for downloading, installing and using libjpeg-turbo.

    We recommend trying a method suitable for your environment first, if possible.

    -###
    -3.17 - How do I compile and install ImageMagick for entries that require it? +

    3.17 - How do I compile and install ImageMagick for entries that require it?

    This depends on your operating system for which we describe a couple below.

    @@ -1540,10 +1499,9 @@ packages: one for compiling and one for linking / running.

    Go to the ImageMagick website and follow their instructions for downloading, installing and using ImageMagick.

    We recommend trying a method suitable for your environment first, if possible.

    -###
    -3.18 - How do I compile and install OpenGL for entries that require it? +

    3.18 - How do I compile and install OpenGL for entries that require it?

    This depends on your operating system for which we describe a couple below.

    @@ -1581,10 +1539,9 @@ packages: one for compiling and one for linking / running.

    Go to the Vulkan website and follow their instructions for downloading, installing and using OpenGL.

    We recommend trying a method suitable for your environment first, if possible.

    -###
    -3.19 - What kind of make(1) compatibility does the IOCCC support and will it support other kinds? +

    3.19 - What kind of make(1) compatibility does the IOCCC support and will it support other kinds?

    For the IOCCC mkiocccentry submission @@ -1604,13 +1561,11 @@ to the top level directory of the winner repo you can do:

    it like:

        gmake MAKE=gmake

    though of course for both you may specify a rule or rules to run.

    -##
    -Section 4: Changes made to IOCCC entries +

    Section 4: Changes made to IOCCC entries

    -###
    -FAQ 4.0: Why are some winning entry remarks incongruent with the winning IOCCC code? +

    FAQ 4.0: Why are some winning entry remarks incongruent with the winning IOCCC code?

    It is very likely in this case that the code was fixed to work for modern systems as part of the reworking of the website. If you have this problem in @@ -1620,10 +1575,9 @@ favourite entries of all time is 1984/mullen the entry’s dirname there would be mullender. Sometimes the original is in an alt version like dirname.alt.c or prog.alt.c. In fact it is advisable to look at the original code when reading the author’s (and sometimes authors’) remarks.

    -###
    -FAQ 4.1: Why were some calls to the libc function gets(3) changed to use fgets(3)? +

    FAQ 4.1: Why were some calls to the libc function gets(3) changed to use fgets(3)?

    Some may wonder: “Doesn’t this tamper with the entry too much?”

    @@ -1657,10 +1611,9 @@ newline and gets() does not. As the Unix version 7 man page used to

    We’re not sure how this is compatibility but either way it can cause a problem and it is this that has complicated most of the fixes though again some can look almost identical.

    -###
    -FAQ 4.2: What was changed in an IOCCC entry source code? +

    FAQ 4.2: What was changed in an IOCCC entry source code?

    We have set up make rules to easily do see what was changed in the winning IOCCC @@ -1740,9 +1693,8 @@ just do:

    make DIFF=colordiff diff_alt_prog # for alt to prog diff

    Obviously if you want to view the alt code or the orig code you can just open the files as described above.

    -###
    -FAQ 4.3 - Why do author remarks sometimes not match the source and/or why are there other inconsistencies with the original entry? +

    FAQ 4.3 - Why do author remarks sometimes not match the source and/or why are there other inconsistencies with the original entry?

    If the entry has been fixed for modern systems and this fix required modification to the code then invariably there will be entries where the remarks @@ -1759,21 +1711,18 @@ some cases, such as 1984/mullender, the original code is the same a as no changes were made (there is an alt version for systems that are not VAX-11/PDP-11, however).

    See also FAQ 4.2: What was changed in an IOCCC entry source code?

    -###
    -FAQ 4.4: What is the meaning of the file ending in .orig.c in IOCCC entries? +

    FAQ 4.4: What is the meaning of the file ending in .orig.c in IOCCC entries?

    Due to the fact that the original code has sometimes had to change these files are the original winning entry or as close to as possible to the original that we can find.

    -##
    -Section 5: Updating or correcting IOCCC web site content +

    Section 5: Updating or correcting IOCCC web site content

    -###
    -FAQ 5.0: How may I help the IOCCC? +

    FAQ 5.0: How may I help the IOCCC?

    We welcome your help in fixing IOCCC entries

    @@ -1788,10 +1737,9 @@ while a (mis)feature is not considered a bug and should not be fixedknown bugs file section may offer you important fixing clues.

    We welcome your help on fixing the IOCCC web site

    -###
    -FAQ 5.1: How do I report a bug in an IOCCC entry? +

    FAQ 5.1: How do I report a bug in an IOCCC entry?

    We do not ‘maintain’ the contest entries as such. The code is made available on an ‘AS @@ -1810,10 +1758,9 @@ entry for information on how to submit a fix to an IOCCC entry. See also the FAQ 6.10 How does someone make a change to a file and submit that change as a GitHub pull request for more information about pull requests.

    -###
    -FAQ 5.2: How may I submit a fix to an IOCCC entry? +

    FAQ 5.2: How may I submit a fix to an IOCCC entry?

    If you see a problem with an IOCCC entry, first check the known bugs @@ -1848,10 +1795,9 @@ make a change to a file and submit that change as a GitHub pull request for more information about pull requests.

    Note that we’re much more inclined to accept an author’s fixes but the judges have the final say in the matter.

    -###
    -FAQ 5.3: How may I report an IOCCC web site problem? +

    FAQ 5.3: How may I report an IOCCC web site problem?

    If you discover a problem with the IOCCC web site that is related @@ -1870,10 +1816,9 @@ if the problem has already been reported. If it has been reported, feel free to add a comment to the issue. If you do not find an it has been reported, then fee free to open a new IOCCC issue.

    -###
    -FAQ 5.4: How may I submit a fix to the IOCCC web site? +

    FAQ 5.4: How may I submit a fix to the IOCCC web site?

    For IOCCC web site problems that relate to a particular IOCCC entry, please @@ -1924,10 +1869,9 @@ markdown file, you will read:

    modify JSON files and/or change a bin directory tool.

    If this happens, consider opening up an IOCCC issue and ask for help. See FAQ 5.3 for information on opening up an IOCCC issue.

    -##
    -FAQ 5.5: How may I correct or update IOCCC author information? +

    FAQ 5.5: How may I correct or update IOCCC author information?

    Authors of IOCCC winning entries are kept in JSON files of the form:

    @@ -1945,10 +1889,9 @@ of the ioccc-src/winner repo.< entry. See also the FAQ 6.10 How does someone make a change to a file and submit that change as a GitHub pull request for more information about pull requests.

    -##

    We would appreciate if you try to fix the broken (the link goes nowhere) or wrong @@ -1984,13 +1927,11 @@ if the text in some index.html file was:

    replace that text with:

        See the **author's description of the program** (sorry the content is no longer available) for more information.

    If you just wish to report the bad link issue, see FAQ 5.3.

    -##
    -Section 6: Miscellaneous IOCCC +

    Section 6: Miscellaneous IOCCC

    -###
    -FAQ 6.0: How did an entry that breaks the size rule 2 win the IOCCC? +

    FAQ 6.0: How did an entry that breaks the size rule 2 win the IOCCC?

    As entries have been fixed it is entirely possible that some of the entries no longer fit within the year’s size restrictions. Invariably the length of columns @@ -2002,23 +1943,20 @@ original winning entries as compressed tar files for a given year.

    In some cases the entry may have abused rule 2 and declared an “abuse of the rules” (although now blatant abuse of the rules to get around rule 2 size limits is discouraged).

    -###
    -FAQ 6.1: Is there a list of known bugs and misfeatures of IOCCC entries? +

    FAQ 6.1: Is there a list of known bugs and misfeatures of IOCCC entries?

    Yes! Please see bugs.html for a list of known bugs and/or issues of a variety of kinds.

    Note that just because an entry is not in the bugs file does not mean there is not an issue and note that some issues are simply missing files, dead URL(s) or something like that.

    -###
    -FAQ 6.2: May I mirror the IOCCC web site? +

    FAQ 6.2: May I mirror the IOCCC web site?

    We are not accepting mirror requests at this time, sorry. However you are free to fork the IOCCC winner repo. We do ask that your fork keep up to date with the latest changes when possible.

    -###
    -FAQ 6.3: May I use parts of the IOCCC in an article, book, newsletter, or instructional material? +

    FAQ 6.3: May I use parts of the IOCCC in an article, book, newsletter, or instructional material?

    While IOCCC judges look favorably on most requests to use IOCCC material, we request that you ask the IOCCC judges first.

    @@ -2028,9 +1966,8 @@ the IOCCC Judges page.

    the CC BY-SA 4.0 License.

    See FAQ 6.11 for additional information on the Copyright and CC BY-SA 4.0 License.

    -###
    -FAQ 6.4: Why do you sometimes use the first person plural? +

    FAQ 6.4: Why do you sometimes use the first person plural?

    As a precedent for first person plural, we may sight Two-, @@ -2061,10 +1998,9 @@ may still be in effect and the 1982 F D C Willard

    -###
    -FAQ 6.5: What is an author handle? +

    FAQ 6.5: What is an author handle?

    An author_handle is string that refers to a given author and is unique to the @@ -2101,10 +2037,9 @@ in the case of 2005/anon.

        Anonymous_[0-9][0-9][0-9][0-9][.0-9]*$

    See FAQ 5.5 for information about how to update and/or correct IOCCC author information.

    -###
    -FAQ 6.6: What is a author_handle.json file and how are they used? +

    FAQ 6.6: What is a author_handle.json file and how are they used?

    TL:DR: The contents of these JSON files contain the best known @@ -2378,10 +2313,9 @@ is a valid entry ID.

    See FAQ 6.7 for information about entry ids.

    See FAQ 5.5 for information about how to update and/or correct IOCCC author information.

    -###
    -FAQ 6.7: What is a entry_id? +

    FAQ 6.7: What is a entry_id?

    A entry_id is a string that identifies a winning entry of the IOCCC.

    @@ -2391,9 +2325,8 @@ of 2020 is found under the following directory:

        2020/ferguson2

    The entry_id for that winning entry is:

        2020_ferguson2
    -###
    -FAQ 6.8: What is the purpose of the .top, .year and .path files? +

    FAQ 6.8: What is the purpose of the .top, .year and .path files?

    The .top file resides at the top directory. This file contains the complete list of IOCCC years.

    @@ -2404,10 +2337,9 @@ These files contain the directory path from the top directory. For example see 1984/anonymous/.path.

    The .top, .year and .path files are generated from the top level Makefile, by:

        make genpath
    -###
    -FAQ 6.9: What is the current meaning of the IOCCC terms Author, Entry, and Submission? +

    FAQ 6.9: What is the current meaning of the IOCCC terms Author, Entry, and Submission?

    The IOCCC is now attempting to use the following terms:

    @@ -2457,10 +2389,9 @@ refer to what is now a submission. In a number of historical cases, such as old rules and old guidelines, terms such as entry may still be found. Moreover, out of habit, the IOCCC judges sometimes use old names such as entry when they should use submission. Sorry (tm Canada)! :-)

    -###
    -FAQ 6.10: How does someone make a change to a file and submit that change as a GitHub pull request? +

    FAQ 6.10: How does someone make a change to a file and submit that change as a GitHub pull request?

    First, if you do not already have a GitHub account or you have not installed an @@ -2620,10 +2551,9 @@ has the merge. To do this from the command line, assuming the fork in the above example, you would type:

        git checkout master && git pull https://github.com/ioccc-src/temp-test-ioccc.git master && git push origin master

    This will merge your pull request to your fork.

    -###
    -FAQ 6.11: Am I allowed to use IOCCC content? +

    FAQ 6.11: Am I allowed to use IOCCC content?

    Disclaimer: This FAQ is not a license, has no legal diff --git a/faq.md b/faq.md index 175912cca..b6e03d30c 100644 --- a/faq.md +++ b/faq.md @@ -87,10 +87,16 @@ other inconsistencies with the original entry?](#faq4_3) # The IOCCC FAQ -##

    Section 0: Submitting entries to a new IOCCC
    +
    +## Section 0: Submitting entries to a new IOCCC +
    -###
    FAQ 0.0: How may I submit to the IOCCC?
    +
    +
    +### FAQ 0.0: How may I submit to the IOCCC? +
    +
    To submit your code to the IOCCC, you **MUST** follow these steps: @@ -181,7 +187,9 @@ To submit your code to the IOCCC, you **MUST** follow these steps: -###
    FAQ 0.1: What types of entries have been over-submitted to the IOCCC?
    +
    +### FAQ 0.1: What types of entries have been over-submitted to the IOCCC? +
    There are types of entries that show up over and over again. The IOCCC judges, and we suspect the public that enjoy viewing the @@ -293,7 +301,9 @@ on an 'overused theme' and why the judges should not simply toss it out as being boring. -###
    FAQ 0.2: What should I put in my entry's Makefile?
    +
    +### FAQ 0.2: What should I put in my entry's Makefile? +
    We recommend starting with the [sample Makefile](https://github.com/ioccc-src/mkiocccentry/blob/master/Makefile.example) @@ -320,7 +330,9 @@ make compatible](https://www.gnu.org/software/make/) `make(1)` command that is compatible with GNU Make version 3.81. -###
    FAQ 0.3: May I use a different source or compiled filename than prog.c or prog?
    +
    +### FAQ 0.3: May I use a different source or compiled filename than prog.c or prog? +
    While your entry's source filename, as submitted, must be `prog.c`, your entry's `Makefile` may copy `prog.c` to a different filename as part of the compiling/building process. For example: @@ -352,7 +364,9 @@ For example: ``` -###
    FAQ 0.4: What platform should I assume for my entry?
    +
    +### FAQ 0.4: What platform should I assume for my entry? +
    Your entry must compile with GCC and run under at least one flavor of UNIX (e.g. Linux or Solaris). To improve chances to win, it should work under both BSD and @@ -363,7 +377,11 @@ even better. Being able to compile with other compilers like clang is also a good thing. -###
    FAQ 0.5: How may I comment or make a suggestion on IOCCC rules, guidelines and tools?
    +
    +
    +### FAQ 0.5: How may I comment or make a suggestion on IOCCC rules, guidelines and tools? +
    +
    The [IOCCC judges](judges.html) to welcome feedback on the [IOCCC rules](next/rules.html), [IOCCC guidelines](next/guidelines.html) @@ -389,10 +407,16 @@ discussion with the [IOCCC judges](judges.html), then see [How to contact the IOCCC](contact.html). -##
    Section 1: History of the IOCCC
    +
    +## Section 1: History of the IOCCC +
    -###
    FAQ 1.0: How did the IOCCC get started?
    +
    +
    +### FAQ 1.0: How did the IOCCC get started? +
    +
    One day (1984 March 23 to be exact), Larry Bassel and I (Landon Curt Noll) were working for National Semiconductor's Genix porting group, we @@ -470,7 +494,9 @@ P.S. Part of the inspiration for making the IOCCC a contest goes to the P^2.S. See the [overall README](all/index.html) for more details. -###
    FAQ 1.1: Why are some years missing IOCCC entries?
    +
    +### FAQ 1.1: Why are some years missing IOCCC entries? +
    Some years, such as 1997, 1999, 2002-2003, 2007-2010, 2016-2017, 2021-2023, no IOCCC was held. @@ -481,7 +507,9 @@ The pause during the 2021-2023 period was due to the IOCCC judges developing too make is much more likely for the IOCCC to be held in a yearly basis later on. -###
    FAQ 1.2: What is the history of the IOCCC web site?
    +
    +### FAQ 1.2: What is the history of the IOCCC web site? +
    #### In the beginning of www.ioccc.org @@ -669,7 +697,11 @@ repo](https://github.com/ioccc-src/winner) resulting in many, many substantial i to the [official IOCCC web site](https://www.ioccc.org). -###
    FAQ 1.3: How has the IOCCC size limit rule changed over the years?
    +
    +
    +### FAQ 1.3: How has the IOCCC size limit rule changed over the years? +
    +
    The IOCCC size rule has changed over the years. @@ -720,15 +752,21 @@ NOTE: The size rule was actually rule 1. * Rule 2b: 2503 -##
    Section 2: IOCCC Judging process
    +
    +## Section 2: IOCCC Judging process +
    -###
    FAQ 2.0: How many entries do the judges receive for a given IOCCC?
    +
    +### FAQ 2.0: How many entries do the judges receive for a given IOCCC? +
    By tradition, we do not say. -###
    FAQ 2.1: What should I put in the remarks.md file of my entry?
    +
    +### FAQ 2.1: What should I put in the remarks.md file of my entry? +
    While you may put in as much or as little as you wish into your entry's `remarks.md` file, we do have few important suggestions: @@ -771,14 +809,18 @@ this is not clear! - leaving the remark section empty. -###
    FAQ 2.2: Why don't you publish entries that do not win?
    +
    +### FAQ 2.2: Why don't you publish entries that do not win? +
    Because the publication on the IOCCC site **_IS_** the award! Anyone is free to put their IOCCC hopefuls, lookalikes and/or entries that do not win on their web page for everyone to see. -###
    FAQ 2.3: How much time does it take to judge the contest?
    +
    +### FAQ 2.3: How much time does it take to judge the contest? +
    It takes a fair amount of time to setup, run, answer email, process entries, review entries, trim down the set entries to a set of winning entries, doing the @@ -795,7 +837,9 @@ on at least a couple different platforms, at least one of them being UNIX or POSIX-conforming. -###
    FAQ 2.4: How many judging rounds do you have?
    +
    +### FAQ 2.4: How many judging rounds do you have? +
    Are you trying to trick us? :-) @@ -806,7 +850,9 @@ when usually report when the IOCCC judges start near final judging rounds, and sometimes we also report when we enter what we believe is the final judging round, so you may guess that we have at least 3 rounds. :-) The actual number of rounds is certainly more than 3. -###
    FAQ 2.5: Why do some IOCCC entries receive the Grand Prize or Best of Show award?
    +
    +### FAQ 2.5: Why do some IOCCC entries receive the Grand Prize or Best of Show award? +
    In some years, the IOCCC judges discover a truly amazing IOCCC entry that stands out among all of the other IOCCC entries received that year. @@ -846,7 +892,9 @@ These could be considered the 'best entry' for those years with 1 or more other entries that came in close behind. -###
    FAQ 2.6: How are IOCCC entries announced?
    +
    +### FAQ 2.6: How are IOCCC entries announced? +
    Once the [IOCCC](../index.html) closes, the judges will: @@ -868,10 +916,14 @@ winning entries page](../years.html). * Update the [IOCCC news](../news.html) page. -##
    Section 3: Compiling and running IOCCC entries
    +
    +## Section 3: Compiling and running IOCCC entries +
    -###
    FAQ 3.0: What Makefile rules are available to build or clean up IOCCC entries?
    +
    +### FAQ 3.0: What Makefile rules are available to build or clean up IOCCC entries? +
    In general the best way to compile everything in an entry directory is to run: @@ -923,7 +975,9 @@ enable or disable additional warnings or flags. Even so different versions or compilers might do different things, have different defects or other issues. -###
    FAQ 3.1: Why doesn't this IOCCC entry compile?
    +
    +### FAQ 3.1: Why doesn't this IOCCC entry compile? +
    Some entries that won the IOCCC, particularly entries from long ago, no longer compile on more modern systems because the C language has evolved (i.e. the modern C compilers @@ -949,7 +1003,9 @@ that works for modern systems but one can view the original code in the `dirname.alt.c` or `prog.alt.c`). -###
    FAQ 3.2: Why does a IOCCC entry fail on my 64-bit system?
    +
    +### FAQ 3.2: Why does a IOCCC entry fail on my 64-bit system? +
    Unfortunately some older entries are non-portable and require 32-bit support or 32-bit binaries. A problem system here is macOS Catalina (10.15) as as of that @@ -981,7 +1037,9 @@ a file and submit that change as a GitHub pull request](#ull_request) for more information about pull requests. -###
    FAQ 3.3: Why do some IOCCC entries fail to compile under macOS?
    +
    +### FAQ 3.3: Why do some IOCCC entries fail to compile under macOS? +
    If the entry requires gcc and you did not explicitly install gcc in macOS you will not be able to run or use these entries. This is because macOS gcc is @@ -998,7 +1056,9 @@ Please see [FAQ 5.2 How may I submit a fix to an IOCCC entry](#fix_an_entry) for details. -###
    FAQ 3.4: Why does clang or gcc fail to compile an IOCCC entry?
    +
    +### FAQ 3.4: Why does clang or gcc fail to compile an IOCCC entry? +
    Although we have fixed numerous entries to work with clang (sometimes in an alt version but usually in the program itself) there are some that simply cannot be @@ -1023,7 +1083,9 @@ make a change to a file and submit that change as a GitHub pull request](#ull_request) for more information about pull requests. -###
    FAQ 3.5: What is this cb tool that is mentioned in the IOCCC?
    +
    +### FAQ 3.5: What is this cb tool that is mentioned in the IOCCC? +
    This was a C beautifier for Unix, both AT&T and Berkeley, but it seems to no longer be available, code wise, except for Plan 9, but Plan 9 was never used for @@ -1031,7 +1093,9 @@ judging the IOCCC. A Unix man page for `cb` [still exists](https://www.ibm.com/docs/en/aix/7.3?topic=c-cb-command). -###
    FAQ 3.6: An IOCCC entry messed up my terminal application, how do I fix this?
    +
    +### FAQ 3.6: An IOCCC entry messed up my terminal application, how do I fix this? +
    The simplest way to do this is to type `reset`. If echo was disabled you can get usually away with `stty echo`. Sometimes you can also get away with `stty sane`. @@ -1039,10 +1103,18 @@ usually away with `stty echo`. Sometimes you can also get away with `stty sane`. will too but it won't reset the terminal). -###
    FAQ 3.7: How do I run an IOCCC entry that requires X11?
    +
    +
    +
    +### FAQ 3.7: How do I run an IOCCC entry that requires X11? +
    +
    +
    -####
    Generally, to compile and run an IOCCC entry that requires X11:
    +
    +#### Generally, to compile and run an IOCCC entry that requires X11: +
    You must have the X11 related include files and X11 libraries in order to compile the IOCCC entry. In order to do this you will need to install Xorg and @@ -1065,7 +1137,9 @@ By X11 terminal application we suggest one of: See below for various system related hints that may be of help. -####
    X.org server has been deprecated
    +
    +#### X.org server has been deprecated +
    The Red Hat RHEL9.0 release notes state that [X.org Server is now deprecated](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/9.0_release_notes/deprecated_functionality#deprecated-functionality_graphics-infrastructures). @@ -1226,7 +1300,11 @@ See the [X.org](https://x.org/wiki/) foundation web site. See the above note for details. -###
    FAQ 3.8: How do I compile an IOCCC entry that requires SDL1 or SDL2?
    +
    +
    +### FAQ 3.8: How do I compile an IOCCC entry that requires SDL1 or SDL2? +
    +
    This depends on your operating system but below are instructions for Linux and macOS with alternative methods for macOS and different package managers with Linux. @@ -1344,7 +1422,11 @@ See the [FAQ 6.10 How does someone make a change to a file and submit that chang as a GitHub pull request](#ull_request) for more information about pull requests. -###
    FAQ 3.9: How do I compile an IOCCC entry that requires (n)curses?
    +
    +
    +### FAQ 3.9: How do I compile an IOCCC entry that requires (n)curses? +
    +
    This depends on your operating system but below are instructions for Linux and macOS with alternative methods for macOS and different package managers with Linux. @@ -1407,7 +1489,11 @@ for downloading, installing and using ncurses. We recommend trying a method suitable for your environment first, if possible. -###
    FAQ 3.10: How do I compile and use an IOCCC entry that requires sound?
    +
    +
    +### FAQ 3.10: How do I compile and use an IOCCC entry that requires sound? +
    +
    This might depend on the entry but most likely the Swiss Army Knife of sound processing programs, [SoX](https://sox.sourceforge.net), will work. How to @@ -1465,7 +1551,9 @@ Usually the index.html file will explain how to use it under Linux so we do not include this here, at least for now. -###
    FAQ 3.11: Why do Makefiles use -Weverything with clang?
    +
    +### FAQ 3.11: Why do Makefiles use -Weverything with clang? +
    While we know that use of `-Weverything` is generally not recommended by `clang` C compiler developers, we do use the `-Weverything` @@ -1569,7 +1657,9 @@ you can get your entry to work well in `clang` it might very well be considered better than other entries. -###
    FAQ 3.12: How do I find out how to send interrupt/EOF etc. for entries that require it?
    +
    +### FAQ 3.12: How do I find out how to send interrupt/EOF etc. for entries that require it? +
    For some entries one needs to send interrupt or EOF or some other signal/other special characters. There are typical defaults like (where `^` = ctrl): @@ -1601,7 +1691,11 @@ reason it's not you might have to do something else including just piping it to just `grep intr` or whatever. -###
    FAQ 3.13: Why does an IOCCC entry fail to compile or or fail run?
    +
    +
    +### FAQ 3.13: Why does an IOCCC entry fail to compile or or fail run? +
    +
    What may have worked years ago may not work well or work at all today. Please note that the IOCCC judges do **NOT** support IOCCC entries. @@ -1639,7 +1733,11 @@ request](https://github.com/ioccc-src/temp-test-ioccc/pulls). Please see [FAQ 5.2](#fix_an_entry) for how to submit a fix to an IOCCC entry. -###
    FAQ 3.14 - How do I compile and install tcpserver for entries that require it?
    +
    +
    +### FAQ 3.14 - How do I compile and install tcpserver for entries that require it? +
    +
    If your OS package manager does not have the package `tcpserver` you can download, making sure you're in a temporary directory, and compile the source @@ -1662,7 +1760,11 @@ That will install it to `/usr/local/bin`. Now you should be able to use the entry in question. -###
    3.15 - How do I compile and install netpbm for entries that require it?
    +
    +
    +### 3.15 - How do I compile and install netpbm for entries that require it? +
    +
    This depends on your operating system for which we describe a couple below. @@ -1739,7 +1841,11 @@ We recommend trying a method suitable for your environment first, if possible. -###
    3.16 - How do I compile and install libjpeg-turbo for entries that require it?
    +
    +
    +### 3.16 - How do I compile and install libjpeg-turbo for entries that require it? +
    +
    This depends on your operating system for which we describe a couple below. @@ -1816,7 +1922,11 @@ for downloading, installing and using libjpeg-turbo. We recommend trying a method suitable for your environment first, if possible. -###
    3.17 - How do I compile and install ImageMagick for entries that require it?
    +
    +
    +### 3.17 - How do I compile and install ImageMagick for entries that require it? +
    +
    This depends on your operating system for which we describe a couple below. @@ -1891,7 +2001,11 @@ for downloading, installing and using ImageMagick. We recommend trying a method suitable for your environment first, if possible. -###
    3.18 - How do I compile and install OpenGL for entries that require it?
    +
    +
    +### 3.18 - How do I compile and install OpenGL for entries that require it? +
    +
    This depends on your operating system for which we describe a couple below. @@ -1963,7 +2077,11 @@ for downloading, installing and using OpenGL. We recommend trying a method suitable for your environment first, if possible. -###
    3.19 - What kind of make(1) compatibility does the IOCCC support and will it support other kinds?
    +
    +
    +### 3.19 - What kind of make(1) compatibility does the IOCCC support and will it support other kinds? +
    +
    For the [IOCCC](https://www.ioccc.org) [mkiocccentry submission toolkit](https://github.com/ioccc-src/mkiocccentry) and the [winning IOCCC @@ -1994,10 +2112,14 @@ it like: though of course for both you may specify a rule or rules to run. -##
    Section 4: Changes made to IOCCC entries
    +
    +## Section 4: Changes made to IOCCC entries +
    -###
    FAQ 4.0: Why are some winning entry remarks incongruent with the winning IOCCC code?
    +
    +### FAQ 4.0: Why are some winning entry remarks incongruent with the winning IOCCC code? +
    It is very likely in this case that the code was fixed to work for modern systems as part of the reworking of the website. If you have this problem in @@ -2009,7 +2131,11 @@ version like `dirname.alt.c` or `prog.alt.c`. In fact it is advisable to look at the original code when reading the author's (and sometimes authors') remarks. -###
    FAQ 4.1: Why were some calls to the libc function `gets(3)` changed to use `fgets(3)`?
    +
    +
    +### FAQ 4.1: Why were some calls to the libc function `gets(3)` changed to use `fgets(3)`? +
    +
    Some may wonder: "Doesn't this tamper with the entry too much?" @@ -2059,7 +2185,11 @@ can look almost identical. -###
    FAQ 4.2: What was changed in an IOCCC entry source code?
    +
    +
    +### FAQ 4.2: What was changed in an IOCCC entry source code? +
    +
    We have set up make rules to easily do see what was changed in the winning IOCCC entry source. Using the `Makefile` in the entry directory, use @@ -2156,7 +2286,9 @@ Obviously if you want to view the alt code or the orig code you can just open the files as described above. -###
    FAQ 4.3 - Why do author remarks sometimes not match the source and/or why are there other inconsistencies with the original entry?
    +
    +### FAQ 4.3 - Why do author remarks sometimes not match the source and/or why are there other inconsistencies with the original entry? +
    If the entry has been fixed for modern systems and this fix required modification to the code then invariably there will be entries where the remarks @@ -2177,17 +2309,25 @@ VAX-11/PDP-11, however). See also [FAQ 4.2: What was changed in an IOCCC entry source code?](#what_changed) -###
    FAQ 4.4: What is the meaning of the file ending in .orig.c in IOCCC entries?
    +
    +### FAQ 4.4: What is the meaning of the file ending in .orig.c in IOCCC entries? +
    Due to the fact that the original code has sometimes had to change these files are the original winning entry or as close to as possible to the original that we can find. -##
    Section 5: Updating or correcting IOCCC web site content
    +
    +## Section 5: Updating or correcting IOCCC web site content +
    -###
    FAQ 5.0: How may I help the IOCCC?
    +
    +
    +### FAQ 5.0: How may I help the IOCCC? +
    +
    ### We welcome your help in fixing IOCCC entries @@ -2206,7 +2346,11 @@ section may offer you important fixing clues. ### We welcome your help on fixing the IOCCC web site -###
    FAQ 5.1: How do I report a bug in an IOCCC entry?
    +
    +
    +### FAQ 5.1: How do I report a bug in an IOCCC entry? +
    +
    We do not 'maintain' the contest entries as such. The code is made available on an 'AS IS' basis. If you have a FIX for an entry, we suggest that you submit your fixes in a [GitHub pull @@ -2229,7 +2373,11 @@ to a file and submit that change as a GitHub pull request](#ull_request) for more information about pull requests. -###
    FAQ 5.2: How may I submit a fix to an IOCCC entry?
    +
    +
    +### FAQ 5.2: How may I submit a fix to an IOCCC entry? +
    +
    If you see a problem with an IOCCC entry, first check the [known bugs](bugs.html) file. In some cases what you might think of as a bug is instead a known @@ -2273,7 +2421,11 @@ Note that we're much more inclined to accept an author's fixes but the judges have the final say in the matter. -###
    FAQ 5.3: How may I report an IOCCC web site problem?
    +
    +
    +### FAQ 5.3: How may I report an IOCCC web site problem? +
    +
    If you discover a problem with the IOCCC web site that is related to a particular IOCCC entry, please see [FAQ 5.1](#report_bug) for @@ -2295,7 +2447,11 @@ has been reported, then fee free to open a [new IOCCC issue](https://github.com/ioccc-src/winner/issues). -###
    FAQ 5.4: How may I submit a fix to the IOCCC web site?
    +
    +
    +### FAQ 5.4: How may I submit a fix to the IOCCC web site? +
    +
    For IOCCC web site problems that relate to a particular IOCCC entry, please see [FAQ 5.2](#fix_an_entry) for information on how submit a fix to an IOCCC entry. @@ -2367,7 +2523,11 @@ If this happens, consider opening up an [IOCCC issue](https://github.com/ioccc-s and ask for help. See [FAQ 5.3](#fix_an_entry) for information on opening up an IOCCC issue. -##
    FAQ 5.5: How may I correct or update IOCCC author information?
    +
    +
    +## FAQ 5.5: How may I correct or update IOCCC author information? +
    +
    Authors of IOCCC winning entries are kept in JSON files of the form: @@ -2393,7 +2553,11 @@ make a change to a file and submit that change as a GitHub pull request](#ull_request) for more information about pull requests. -##
    +
    + +
    We would appreciate if you try to fix the broken (the link goes nowhere) or wrong (the link goes to something that clearly is not the original intent) web link. @@ -2442,10 +2606,14 @@ replace that text with: If you just wish to report the bad link issue, see [FAQ 5.3](#report_web_problem). -##
    Section 6: Miscellaneous IOCCC
    +
    +## Section 6: Miscellaneous IOCCC +
    -###
    FAQ 6.0: How did an entry that breaks the size rule 2 win the IOCCC?
    +
    +### FAQ 6.0: How did an entry that breaks the size rule 2 win the IOCCC? +
    As entries have been fixed it is entirely possible that some of the entries no longer fit within the year's size restrictions. Invariably the length of columns @@ -2461,7 +2629,9 @@ In some cases the entry may have abused rule 2 and declared an get around rule 2 size limits is discouraged). -###
    FAQ 6.1: Is there a list of known bugs and misfeatures of IOCCC entries?
    +
    +### FAQ 6.1: Is there a list of known bugs and misfeatures of IOCCC entries? +
    Yes! Please see [bugs.html](bugs.html) for a list of known bugs and/or issues of a variety of kinds. @@ -2471,12 +2641,16 @@ not an issue and note that some issues are simply missing files, dead URL(s) or something like that. -###
    FAQ 6.2: May I mirror the IOCCC web site?
    +
    +### FAQ 6.2: May I mirror the IOCCC web site? +
    We are not accepting mirror requests at this time, sorry. However you are free to fork the [IOCCC winner repo](https://github.com/ioccc-src/winner). We do ask that your fork keep up to date with the latest changes when possible. -###
    FAQ 6.3: May I use parts of the IOCCC in an article, book, newsletter, or instructional material?
    +
    +### FAQ 6.3: May I use parts of the IOCCC in an article, book, newsletter, or instructional material? +
    While IOCCC judges look favorably on most requests to use IOCCC material, we request that you ask the [IOCCC judges](judges.html) first. @@ -2491,7 +2665,9 @@ See [FAQ 6.11](#license) for additional information on the [Copyright and CC BY-SA 4.0 License](license.html). -###
    FAQ 6.4: Why do you sometimes use the first person plural?
    +
    +### FAQ 6.4: Why do you sometimes use the first person plural? +
    As a precedent for [first person plural](https://en.wikipedia.org/wiki/Nosism), we may sight [Two-, @@ -2528,7 +2704,11 @@ p.s. Here is an image of F. D. C. Willard: [F D C Willard](png/F.D.C.Willard.png) -###
    FAQ 6.5: What is an author handle?
    +
    +
    +### FAQ 6.5: What is an author handle? +
    +
    An `author_handle` is string that refers to a given author and is unique to the IOCCC. Each author has exactly one `author_handle`. @@ -2594,7 +2774,11 @@ See [FAQ 5.5](#fix_author) for information about how to update and/or correct IOCCC author information. -###
    FAQ 6.6: What is a author_handle.json file and how are they used?
    +
    +
    +### FAQ 6.6: What is a author_handle.json file and how are they used? +
    +
    **TL:DR**: The contents of these JSON files contain the best known information about authors of IOCCC entries and is used to help form @@ -3073,7 +3257,11 @@ See [FAQ 5.5](#fix_author) for information about how to update and/or correct IOCCC author information. -###
    FAQ 6.7: What is a entry_id?
    +
    +
    +### FAQ 6.7: What is a entry_id? +
    +
    A `entry_id` is a string that identifies a winning entry of the IOCCC. @@ -3093,7 +3281,9 @@ The `entry_id` for that winning entry is: ``` -###
    FAQ 6.8: What is the purpose of the .top, .year and .path files?
    +
    +### FAQ 6.8: What is the purpose of the .top, .year and .path files? +
    The [.top](.top) file resides at the top directory. This file contains the complete list of IOCCC years. @@ -3112,7 +3302,11 @@ The .top, .year and .path files are generated from the top level Makefile, by: ``` -###
    FAQ 6.9: What is the current meaning of the IOCCC terms Author, Entry, and Submission?
    +
    +
    +### FAQ 6.9: What is the current meaning of the IOCCC terms Author, Entry, and Submission? +
    +
    The IOCCC is now attempting to use the following terms: @@ -3170,7 +3364,11 @@ such as old rules and old guidelines, terms such as _entry_ may still be found. Moreover, out of habit, the IOCCC judges sometimes use old names such as _entry_ when they should use _submission_. Sorry (tm Canada)! :-) -###
    FAQ 6.10: How does someone make a change to a file and submit that change as a GitHub pull request?
    +
    +
    +### FAQ 6.10: How does someone make a change to a file and submit that change as a GitHub pull request? +
    +
    First, if you do not already have a GitHub account or you have not installed an ssh key to your account you must do so. For this we will assume you do not have @@ -3418,7 +3616,11 @@ example, you would type: This will merge your pull request to your fork. -###
    FAQ 6.11: Am I allowed to use IOCCC content?
    +
    +
    +### FAQ 6.11: Am I allowed to use IOCCC content? +
    +
    **Disclaimer**: This FAQ is **not a license**, has **no legal value**, and only highlights some of the key features and terms of