scitopdf 项目使用教程

scitopdf 项目使用教程

scitopdf bash script to quickly fetch, download and open scientific papers from Sci-Hub's database. 项目地址: https://gitcode.com/gh_mirrors/sc/scitopdf

1. 项目目录结构及介绍

scitopdf/
├── assets/
│   └── ...
├── bin/
│   └── ...
├── LICENSE
├── Makefile
├── README.md
└── scitopdf
    └── ...

• assets/: 存放项目相关的资源文件。
• bin/: 存放可执行文件或脚本。
• LICENSE: 项目的开源许可证文件，本项目使用 GPL-3.0 许可证。
• Makefile: 项目的构建文件，用于编译和安装项目。
• README.md: 项目的说明文档，包含项目的简介、安装方法、使用说明等。
• scitopdf/: 项目的主要代码目录，包含核心功能的实现。

2. 项目启动文件介绍

项目的启动文件是 scitopdf 目录下的脚本文件。该脚本用于快速获取和打开科学论文。启动文件的主要功能包括：

• 识别 URL 和 DOI: 当输入 URL 或 DOI 时，脚本会自动识别并获取相应的论文。
• 处理论文信息: 如果没有提供 URL 或 DOI，脚本会根据输入的论文信息（如标题、作者、期刊等）进行搜索并获取论文。
• 自动打开 PDF: 获取论文后，脚本会自动使用默认的 PDF 阅读器打开论文。

3. 项目配置文件介绍

项目没有明确的配置文件，但可以通过以下方式进行配置：

• 环境变量: 可以通过设置 READER 环境变量来指定默认的 PDF 阅读器。
• 命令行参数: 可以通过命令行参数来配置脚本的行为，例如：
  • -l 或 --list: 从参考文献文件中逐行下载论文。
  • -D 或 --download-dir: 指定存储论文的目录。
  • -u 或 --url: 手动设置 Sci-Hub 的地址。
  • -p 或 --no-auto-open: 禁用自动打开 PDF 文件。
  • -q 或 --quiet: 静默模式，只输出错误信息。
  • -w 或 --wait: 在两次请求之间等待指定的时间（仅适用于 --list 模式）。
  • -b 或 --break-after: 在每 X 次论文搜索后暂停（仅适用于 --list 模式）。
  • -d 或 --break-for: 暂停的持续时间（仅适用于 --list 模式）。
  • --dns: 实验性功能，设置 DNS 以获取 Sci-Hub。
  • --ref: 在终端中显示 BibTex 参考文献并复制到剪贴板。
  • --dmenu: 使用 dmenu 显示提示（更多支持和功能即将推出）。
  • -h 或 --help: 显示帮助菜单。

通过这些配置选项，用户可以根据自己的需求定制 scitopdf 的行为。

scitopdf bash script to quickly fetch, download and open scientific papers from Sci-Hub's database. 项目地址: https://gitcode.com/gh_mirrors/sc/scitopdf