• Top
    • Documentation
    • Books
      • Cert.pl
      • Community-books
      • Project-dir-alist
      • Bookdata
      • Book-hash
      • Uncertified-books
      • Sysfile
      • Show-books
      • Best-practices
        • Working-with-packages
        • Theory-management
        • Naming-rewrite-rules
        • Conventional-normal-forms
        • Where-do-i-place-my-book
        • File-names
          • File-extensions
          • Remove-whitespace
          • Finite-reasoning
        • Books-reference
        • Where-do-i-place-my-book
        • Books-tour
      • Recursion-and-induction
      • Boolean-reasoning
      • Projects
      • Debugging
      • Std
      • Proof-automation
      • Macro-libraries
      • ACL2
      • Interfacing-tools
      • Hardware-verification
      • Software-verification
      • Testing-utilities
      • Math
    • Best-practices

    File-names

    Restrictions to follow for naming books, directories, and other files.

    Recommendations

    1. All file names and directory should use strictly lower-case, printable ASCII letters.
    2. Spaces and odd punctuation characters (e.g., beyond dash, underscore, and period) should not be used.
    3. Dashes should generally be preferred over underscores.

    Rationale

    These name restrictions encourage portability across different operating systems, file systems, etc. (Some file systems restrict certain characters, or differ from one another with respect to case sensitivity.)

    Avoiding file names with spaces and special characters helps to makes it easier to write scripts or to write quick, one-off shell commands to process the books without worrying overly much about escaping.